kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify language for concept templates (#11737) 

Clearer intro line

More edits
This commit is contained in:
Zach Corleissen 2018-12-16 19:00:13 -08:00 committed by Kubernetes Prow Robot
parent 7f9e1d59fc
commit 475ffbdd6c
1 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
content/en/docs/contribute/style/page-templates.md
View File

@ -65,17 +65,13 @@ To write a new concept page, create a Markdown file in a subdirectory of the
{{%/* /capture */%}} {{%/* /capture */%}}
``` ```
- Within each section, write your content. Use the following guidelines: - Fill each section with content. Follow these guidelines:
- Use a minimum of H2 headings (with two leading `#` characters). The sections - Organize content with H2 and H3 headings.
themselves are titled automatically by the template. - For `overview`, set the topic's context with a single paragraph.
- For `overview`, use a paragraph to set context for the entire topic. - For `body`, explain the concept.
- For `body`, explain the concept using free-form Markdown. - For `whatsnext`, provide a bulleted list of topics (5 maximum) to learn more about the concept.
- For `whatsnext`, give a bullet list of up to 5 topics the reader might be
interested in reading next.
An example of a published topic that uses the concept template is [Annotations](/docs/concepts/overview/working-with-objects/annotations/) is a published example of the concept template. This page also uses the concept template.
[Annotations](/docs/concepts/overview/working-with-objects/annotations/). The
page you are currently reading also uses the concept template.
## Task template ## Task template