Skip to content

Commit 76cd022

Browse files
cool88skipjack
authored andcommitted
docs(writers-guide): update writers-guide (#1277)
Make some tweaks and and add a section on YAML frontmatter and the available options.
1 parent f9e49f4 commit 76cd022

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

content/writers-guide.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,49 @@
22
title: Writer's Guide
33
---
44

5+
The following sections contain all you need to know about editing and formatting the content within this site. Make sure to do some research before starting your edits or additions. Sometimes the toughest part is finding where the content should live and determining whether or not it already exists.
6+
7+
58
## Process
69

710
1. Check related issue if an article links to one.
811
2. Hit `edit` and expand on the structure.
912
3. PR changes.
1013

14+
15+
## YAML Frontmatter
16+
17+
Each article contains a small section at the top written in [YAML Frontmatter]():
18+
19+
``` md
20+
---
21+
title: My Article
22+
sort: 3
23+
contributors:
24+
- [github username]
25+
related:
26+
- title: Title of Related Article
27+
url: [url of related article]
28+
---
29+
```
30+
31+
Let's break these down:
32+
33+
- `title`: The name of the article.
34+
- `sort`: The order of the article within its section.
35+
- `contributors`: A list of GitHub usernames who have contributed to this article.
36+
- `related`: Any related reading or useful examples.
37+
38+
Note that `related` will generate a __Further Reading__ section at the bottom of the page and `contributors` will yield a __Contributors__ section below it. If you edit an article and would like recognition, please feel free to add your GitHub username to the `contributors` list.
39+
40+
1141
## Article Structure
1242

13-
1. Brief introduction - a paragraph or two so you get the basic idea. Tell what you are going to tell.
14-
2. Main content - tell what you promised to tell.
15-
3. Conclusion - tell what you told and recap the main points.
16-
4. References - link to related articles and external resources so people can read and learn more about the topic.
43+
1. Brief Introduction - a paragraph or two so you get the basic idea about the what and why.
44+
2. Outline Remaining Content – how the content will be presented.
45+
3. Main Content - tell what you promised to tell.
46+
4. Conclusion - tell what you told and recap the main points.
47+
1748

1849
## Running the Site
1950

@@ -23,6 +54,7 @@ title: Writer's Guide
2354

2455
The site will update itself as you make changes.
2556

57+
2658
## Typesetting
2759

2860
* webpack should always be written in lower-case letters. Even at the beginning of a sentence. ([source](https://github.com/webpack/media#name))
@@ -31,6 +63,7 @@ The site will update itself as you make changes.
3163
* Use "webpack 2" to refer to a specific webpack version (~~"webpack v2"~~)
3264
* Use ES5; ES2015, ES2016, … to refer to the ECMAScript standards (~~ES6~~, ~~ES7~~)
3365

66+
3467
## Formatting
3568

3669
### Code

0 commit comments

Comments
 (0)