New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Elaborate on excluding items from processing #6136

Merged
merged 1 commit into from Sep 22, 2017

Conversation

Projects
None yet
4 participants
@ashmaroli
Member

ashmaroli commented Jun 14, 2017

In light of recent discussions on the exclude: configuration, this PR elaborates the troubleshooting tip on that matter

/cc @jekyll/documentation

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Jun 14, 2017

Member

not very happy with the flow of the text here.. feel free to edit as required.. 😉

Member

ashmaroli commented Jun 14, 2017

not very happy with the flow of the text here.. feel free to edit as required.. 😉

@parkr parkr added the documentation label Jun 14, 2017

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Jun 15, 2017

Member

IMHO It's typically the kind of explanation that belongs to a release post.

Member

DirtyF commented Jun 15, 2017

IMHO It's typically the kind of explanation that belongs to a release post.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Jun 15, 2017

Member

It's typically the kind of explanation that belongs to a release post.

I see.. but an average user won't consult a release-post when trying to solve a particular problem..

Member

ashmaroli commented Jun 15, 2017

It's typically the kind of explanation that belongs to a release post.

I see.. but an average user won't consult a release-post when trying to solve a particular problem..

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Jun 15, 2017

Member

an average user won't consult a release-post when trying to solve a particular problem

Chances are people will use a search engine when they encounter a problem, and then hopefully read the release post who explains the changes as it's one of the few documents indexed about it.

My point is we can not keep all changes related to a previous minor version in the docs, it could become unreadable. AFAIC documentation should reflect the current state of the software. That's why I'd rather point to changelog or release posts to explain minor changes.

Member

DirtyF commented Jun 15, 2017

an average user won't consult a release-post when trying to solve a particular problem

Chances are people will use a search engine when they encounter a problem, and then hopefully read the release post who explains the changes as it's one of the few documents indexed about it.

My point is we can not keep all changes related to a previous minor version in the docs, it could become unreadable. AFAIC documentation should reflect the current state of the software. That's why I'd rather point to changelog or release posts to explain minor changes.

@DirtyF

DirtyF approved these changes Sep 22, 2017

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Sep 22, 2017

Member

Let's hope this saves some headache to users.

@jekyllbot: merge +docs

Member

DirtyF commented Sep 22, 2017

Let's hope this saves some headache to users.

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit 9d7f0c1 into jekyll:master Sep 22, 2017

0 of 2 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build failed
Details

@ashmaroli ashmaroli deleted the ashmaroli:troubleshoot-exclude branch Sep 22, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment