whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Copyedit and update with escape characters (#10003)

Browse Source 
* Copyedit and update with escape characters

- Use escape characters for {{< toc >}}.
- Copyedit the content.

* Remove the {{< toc >}} reference

The template does not need a {{< toc >}} as the TOC will be generated by default. Therefore, removed this info from the doc.
This commit is contained in:
shavidissa
2018-08-21 16:55:58 -05:00
committed by k8s-ci-robot
parent b8b6477344
commit 94db355ef7
1 changed files with 3 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/contribute/style/page-templates.md
+3 -13
View File
@@ -31,7 +31,7 @@ template to use for a new topic, start with the
A concept page explains some aspect of Kubernetes. For example, a concept A concept page explains some aspect of Kubernetes. For example, a concept
page might describe the Kubernetes Deployment object and explain the role it page might describe the Kubernetes Deployment object and explain the role it
plays as an application is deployed, scaled, and updated. Typically, concept plays as an application once it is deployed, scaled, and updated. Typically, concept
pages don't include sequences of steps, but instead provide links to tasks or pages don't include sequences of steps, but instead provide links to tasks or
tutorials. tutorials.
@@ -59,8 +59,6 @@ To write a new concept page, create a Markdown file in a subdirectory of the
{{%/* /capture */%}} {{%/* /capture */%}}
{{</* toc */>}}
{{%/* capture body */%}} {{%/* capture body */%}}
{{%/* /capture */%}} {{%/* /capture */%}}
@@ -76,7 +74,6 @@ To write a new concept page, create a Markdown file in a subdirectory of the
- Use a minimum of H2 headings (with two leading `#` characters). The sections - Use a minimum of H2 headings (with two leading `#` characters). The sections
themselves are titled automatically by the template. themselves are titled automatically by the template.
- For `overview`, use a paragraph to set context for the entire topic. - For `overview`, use a paragraph to set context for the entire topic.
- Add the `{{< toc >}}` shortcode to show an in-page table of contents.
- For `body`, explain the concept using free-form Markdown. - For `body`, explain the concept using free-form Markdown.
- For `whatsnext`, give a bullet list of up to 5 topics the reader might be - For `whatsnext`, give a bullet list of up to 5 topics the reader might be
interested in reading next. interested in reading next.
@@ -116,8 +113,6 @@ To write a new task page, create a Markdown file in a subdirectory of the
{{%/* /capture */%}} {{%/* /capture */%}}
{{</* toc */>}}
{{%/* capture prerequisites */%}} {{%/* capture prerequisites */%}}
{{</* include "task-tutorial-prereqs.md" */>}} {{</* version-check */>}} {{</* include "task-tutorial-prereqs.md" */>}} {{</* version-check */>}}
@@ -143,10 +138,8 @@ To write a new task page, create a Markdown file in a subdirectory of the
- Use a minimum of H2 headings (with two leading `#` characters). The sections - Use a minimum of H2 headings (with two leading `#` characters). The sections
themselves are titled automatically by the template. themselves are titled automatically by the template.
- For `overview`, use a paragraph to set context for the entire topic. - For `overview`, use a paragraph to set context for the entire topic.
- Add the `{{< toc >}}` shortcode to show an in-page table of contents. - For `prerequisites`, use bullet lists when possible. Start adding additional
- For `prerequisites`, use bullet lists when possible. Add additional prerequisites below the `include`. The default prerequisites include a running Kubernetes cluster.
prerequisites below the ones included by the `include` in the example
above. The default prerequisites include a running Kubernetes cluster.
- For `steps`, use numbered lists. - For `steps`, use numbered lists.
- For discussion, use normal content to expand upon the information covered - For discussion, use normal content to expand upon the information covered
in `steps`. in `steps`.
@@ -190,8 +183,6 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
{{%/* /capture */%}} {{%/* /capture */%}}
{{</* toc */>}}
{{%/* capture prerequisites */%}} {{%/* capture prerequisites */%}}
{{</* include "task-tutorial-prereqs.md" */>}} {{</* version-check */>}} {{</* include "task-tutorial-prereqs.md" */>}} {{</* version-check */>}}
@@ -220,7 +211,6 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
- Use a minimum of H2 headings (with two leading `#` characters). The sections - Use a minimum of H2 headings (with two leading `#` characters). The sections
themselves are titled automatically by the template. themselves are titled automatically by the template.
- For `overview`, use a paragraph to set context for the entire topic. - For `overview`, use a paragraph to set context for the entire topic.
- Add the `{{< toc >}}` shortcode to show an in-page table of contents.
- For `prerequisites`, use bullet lists when possible. Add additional - For `prerequisites`, use bullet lists when possible. Add additional
prerequisites below the ones included by default. prerequisites below the ones included by default.
- For `objectives`, use bullet lists. - For `objectives`, use bullet lists.