Docs: Reorganized to avoid misunderstandings. #9434
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original headings made it seem that sections after Step 5 could be additional steps. And summary of workflow without a link to the full workflow could make a reader think that the summary is the whole workflow.
|
LGTM |
aladdin-add
approved these changes
Oct 14, 2017
not-an-aardvark
approved these changes
Oct 14, 2017
|
Thanks for contributing! |
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Original headings made it seem that sections after Step 5 could be additional steps.
And summary of workflow without a link to the full workflow could make a reader think
that the summary is the whole workflow.
What is the purpose of this pull request? (put an "X" next to item)
[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Reorganized headings to cleanly distinguish the 5 steps from the following reference info,
and reduced the workflow summary to a reference to the full workflow documentation, to
prevent contributors from mis-believing that the summary is the entire workflow. This also
implies that any revision in the workflow need not be made in 2 places.
Is there anything you'd like reviewers to focus on?