Update Writer's Guide #1277
Merged
Update Writer's Guide #1277
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
simon04
reviewed
Jun 8, 2017
content/writers-guide.md
Outdated
| 3. Conclusion - tell what you told and recap the main points. | ||
| 4. References - link to related articles and external resources so people can read and learn more about the topic. | ||
| 1. Brief introduction - a paragraph or two so you get the basic idea about - the what and why. | ||
| 2. Structure description for the "Main Content" - the how - how you will tell it in a brief paragraph (e.g. a new plugin or a webpack concept) |
There was a problem hiding this comment.
I find the "the how - how you will tell" confusing. What about "Outline for the remaining page – how the content will be presented"?
There was a problem hiding this comment.
That's exactly what I wanted to say. Thanks!
content/writers-guide.md
Outdated
| 2. Structure description for the "Main Content" - the how - how you will tell it in a brief paragraph (e.g. a new plugin or a webpack concept) | ||
| 3. Main content - tell what you promised to tell. | ||
| 4. Conclusion - tell what you told and recap the main points. | ||
| 5. References - link to related articles and external resources so people can read and learn more about the topic. |
There was a problem hiding this comment.
This line is no longer true due to 9659524. It is written into the YAML frontmatter.
There was a problem hiding this comment.
Yeah we should mention that somehow -- something like:
5. References - Use the `related` key in the YAML frontmatter at the top of the file. See the _Frontmatter_ section below for more information.And then we should add a Frontmatter section that documents title, sort, contributors and related.
skipjack
changed the title
skipjack
approved these changes
Jul 2, 2017
|
@cool88 I made the updates so we could push this forward. Thanks for starting this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I think the guideline is missing this important part.