From 94db355ef7e4908dd783a4056372a1e1230adb6d Mon Sep 17 00:00:00 2001 From: shavidissa Date: Tue, 21 Aug 2018 16:55:58 -0500 Subject: [PATCH] Copyedit and update with escape characters (#10003) * 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. --- .../en/docs/contribute/style/page-templates.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/content/en/docs/contribute/style/page-templates.md b/content/en/docs/contribute/style/page-templates.md index 97d6398362..db8122a0f9 100644 --- a/content/en/docs/contribute/style/page-templates.md +++ b/content/en/docs/contribute/style/page-templates.md @@ -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 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 tutorials. @@ -59,8 +59,6 @@ To write a new concept page, create a Markdown file in a subdirectory of the {{%/* /capture */%}} - {{}} - {{%/* capture body */%}} {{%/* /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 themselves are titled automatically by the template. - 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 `whatsnext`, give a bullet list of up to 5 topics the reader might be 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 prerequisites */%}} {{}} {{}} @@ -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 themselves are titled automatically by the template. - 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 - prerequisites below the ones included by the `include` in the example - above. The default prerequisites include a running Kubernetes cluster. + - For `prerequisites`, use bullet lists when possible. Start adding additional + prerequisites below the `include`. The default prerequisites include a running Kubernetes cluster. - For `steps`, use numbered lists. - For discussion, use normal content to expand upon the information covered in `steps`. @@ -190,8 +183,6 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the {{%/* /capture */%}} - {{}} - {{%/* capture prerequisites */%}} {{}} {{}} @@ -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 themselves are titled automatically by the template. - 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 prerequisites below the ones included by default. - For `objectives`, use bullet lists.