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

Updating style.md and write-new-topic.md with markdowns (#16190)

Browse Source
This commit is contained in:
savitharaghunathan
2019-09-11 21:08:38 -04:00
committed by Kubernetes Prow Robot
parent 511e7ab541
commit 8f2d392fb5
2 changed files with 160 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/contribute/style/style-guide.md
+153 -116
View File
@@ -55,14 +55,16 @@ PodTemplateList, not Pod Template List.
Refer to API objects without saying "object," unless omitting "object" Refer to API objects without saying "object," unless omitting "object"
leads to an awkward construction. leads to an awkward construction.
<table> {{< table caption = "Do and Don't - API objects" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>The Pod has two containers.</td><td>The pod has two containers.</td></tr> :--| :-----
<tr><td>The Deployment is responsible for ...</td><td>The Deployment object is responsible for ...</td></tr> The Pod has two containers. | The pod has two containers.
<tr><td>A PodList is a list of Pods.</td><td>A Pod List is a list of pods.</td></tr> The Deployment is responsible for ... | The Deployment object is responsible for ...
<tr><td>The two ContainerPorts ...</td><td>The two ContainerPort objects ...</td></tr> A PodList is a list of Pods. | A Pod List is a list of pods.
<tr><td>The two ContainerStateTerminated objects ...</td><td>The two ContainerStateTerminateds ...</td></tr> The two ContainerPorts ... | The two ContainerPort objects ...
</table> The two ContainerStateTerminated objects ... | The two ContainerStateTerminateds ...
{{< /table >}}
### Use angle brackets for placeholders ### Use angle brackets for placeholders
@@ -77,36 +79,40 @@ represents.
### Use bold for user interface elements ### Use bold for user interface elements
<table> {{< table caption = "Do and Don't - Bold interface elements" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>Click <b>Fork</b>.</td><td>Click "Fork".</td></tr> :--| :-----
<tr><td>Select <b>Other</b>.</td><td>Select 'Other'.</td></tr> Click **Fork**. | Click "Fork".
</table> Select **Other**. | Select "Other".
{{< /table >}}
### Use italics to define or introduce new terms ### Use italics to define or introduce new terms
<table> {{< table caption = "Do and Don't - Use italics for new terms" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>A <i>cluster</i> is a set of nodes ...</td><td>A "cluster" is a set of nodes ...</td></tr> :--| :-----
<tr><td>These components form the <i>control plane.</i></td><td>These components form the <b>control plane.</b></td></tr> A _cluster_ is a set of nodes ... | A "cluster" is a set of nodes ...
</table> These components form the _control plane_. | These components form the **control plane**.
{{< /table >}}
### Use code style for filenames, directories, and paths ### Use code style for filenames, directories, and paths
<table> {{< table caption = "Do and Don't - Use code style for filenames, directories, and paths" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>Open the <code>envars.yaml</code> file.</td><td>Open the envars.yaml file.</td></tr> :--| :-----
<tr><td>Go to the <code>/docs/tutorials</code> directory.</td><td>Go to the /docs/tutorials directory.</td></tr> Open the `envars.yaml` file. | Open the envars.yaml file.
<tr><td>Open the <code>/_data/concepts.yaml</code><!--to-unbreak-atom-highlighting_--> file.</td><td>Open the /_data/concepts.yaml<!--to-unbreak-atom-highlighting_--> file.</td></tr> Go to the `/docs/tutorials` directory. | Go to the /docs/tutorials directory.
</table> Open the `/_data/concepts.yaml` file. | Open the /_data/concepts.yaml file.
{{< /table >}}
### Use the international standard for punctuation inside quotes ### Use the international standard for punctuation inside quotes
<table> {{< table caption = "Do and Don't - Use the international standard for punctuation inside quotes" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>events are recorded with an associated "stage".</td><td>events are recorded with an associated "stage."</td></tr> :--| :-----
<tr><td>The copy is called a "fork".</td><td>The copy is called a "fork."</td></tr> events are recorded with an associated "stage". | events are recorded with an associated "stage."
</table> The copy is called a "fork". | The copy is called a "fork."
{{< /table >}}
## Inline code formatting ## Inline code formatting
@@ -115,13 +121,17 @@ represents.
For inline code in an HTML document, use the `<code>` tag. In a Markdown For inline code in an HTML document, use the `<code>` tag. In a Markdown
document, use the backtick (`). document, use the backtick (`).
<table> {{< table caption = "Do and Don't - Use code style for inline code and commands" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>The <code>kubectl run</code> command creates a Deployment.</td><td>The "kubectl run" command creates a Deployment.</td></tr> :--| :-----
<tr><td>For declarative management, use <code>kubectl apply</code>.</td><td>For declarative management, use "kubectl apply".</td></tr> The `kubectl run`command creates a Deployment. | The "kubectl run" command creates a Deployment.
<tr><td>Enclose code samples with triple backticks. <code>(```)</code></td><td>Enclose code samples with any other syntax.</td></tr> For declarative management, use `kubectl apply`. | For declarative management, use "kubectl apply".
<tr><td>Use single backticks to enclose inline code. For example, `var example = true`.</td><td>Use two asterisks (**) or an underscore (_) to enclose inline code. For example, **var example = true**.</td></tr><tr><td>Use triple backticks before and after a multi-line block of code for fenced code blocks.</td><td>Use multi-line blocks of code to create diagrams, flowcharts, or other illustrations.</td></tr><tr><td>Use meaningful variable names that have a context.</td><td>Use variable names such as 'foo','bar', and 'baz' that are not meaningful and lack context.</td></tr><tr><td>Remove trailing spaces in the code.</td><td>Add trailing spaces in the code, where these are important, because the screen reader will read out the spaces as well.</td></tr> Enclose code samples with triple backticks. `(```)`| Enclose code samples with any other syntax.
</table> Use single backticks to enclose inline code. For example, `var example = true`. | Use two asterisks (**) or an underscore (_) to enclose inline code. For example, **var example = true**.
Use triple backticks before and after a multi-line block of code for fenced code blocks. | Use multi-line blocks of code to create diagrams, flowcharts, or other illustrations.
Use meaningful variable names that have a context. | Use variable names such as 'foo','bar', and 'baz' that are not meaningful and lack context.
Remove trailing spaces in the code. | Add trailing spaces in the code, where these are important, because the screen reader will read out the spaces as well.
{{< /table >}}
{{< note >}} {{< note >}}
The website supports syntax highlighting for code samples, but specifying a language is optional. Syntax highlighting in the code block should conform to the [contrast guidelines.](https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0&showtechniques=141%2C143#contrast-minimum) The website supports syntax highlighting for code samples, but specifying a language is optional. Syntax highlighting in the code block should conform to the [contrast guidelines.](https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0&showtechniques=141%2C143#contrast-minimum)
@@ -129,31 +139,36 @@ The website supports syntax highlighting for code samples, but specifying a lang
### Use code style for object field names ### Use code style for object field names
<table> {{< table caption = "Do and Don't - Use code style for object field names" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>Set the value of the <code>replicas</code> field in the configuration file.</td><td>Set the value of the "replicas" field in the configuration file.</td></tr> :--| :-----
<tr><td>The value of the <code>exec</code> field is an ExecAction object.</td><td>The value of the "exec" field is an ExecAction object.</td></tr> Set the value of the `replicas` field in the configuration file. | Set the value of the "replicas" field in the configuration file.
</table> The value of the `exec` field is an ExecAction object. | The value of the "exec" field is an ExecAction object.
{{< /table >}}
### Use normal style for string and integer field values ### Use normal style for string and integer field values
For field values of type string or integer, use normal style without quotation marks. For field values of type string or integer, use normal style without quotation marks.
<table> {{< table caption = "Do and Don't - Use normal style for string and integer field values" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>Set the value of <code>imagePullPolicy</code> to Always.</td><td>Set the value of <code>imagePullPolicy</code> to "Always".</td></tr> :--| :-----
<tr><td>Set the value of <code>image</code> to nginx:1.8.</td><td>Set the value of <code>image</code> to <code>nginx:1.8</code>.</td></tr> Set the value of `imagePullPolicy` to Always. | Set the value of `imagePullPolicy` to "Always".
<tr><td>Set the value of the <code>replicas</code> field to 2.</td><td>Set the value of the <code>replicas</code> field to <code>2</code>.</td></tr> Set the value of `image` to nginx:1.8. | Set the value of `image` to `nginx:1.8`.
</table> Set the value of the `replicas` field to 2. | Set the value of the `replicas` field to `2`.
{{< /table >}}
## Code snippet formatting ## Code snippet formatting
### Don't include the command prompt ### Don't include the command prompt
<table> {{< table caption = "Do and Don't - Don't include the command prompt" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>kubectl get pods</td><td>$ kubectl get pods</td></tr> :--| :-----
</table> kubectl get pods | $ kubectl get pods
{{< /table >}}
### Separate commands from output ### Separate commands from output
@@ -200,13 +215,14 @@ kind: Pod
A list of Kubernetes-specific terms and words to be used consistently across the site. A list of Kubernetes-specific terms and words to be used consistently across the site.
<table> {{< table caption = "Kubernetes.io word list" >}}
<tr><th>Term</th><th>Usage</th></tr> Term | Usage
<tr><td>Kubernetes</td><td>Kubernetes should always be capitalized.</td></tr> :--- | :----
<tr><td>Docker</td><td>Docker should always be capitalized.</td></tr> Kubernetes | Kubernetes should always be capitalized.
<tr><td>SIG Docs</td><td>SIG Docs rather than SIG-DOCS or other variations.</td></tr> Docker | Docker should always be capitalized.
<tr><td>On-premises</td><td>On-premises or On-prem rather than On-premise or other variations.</td></tr> SIG Docs | SIG Docs rather than SIG-DOCS or other variations.
</table> On-premises | On-premises or On-prem rather than On-premise or other variations.
{{< /table >}}
## Shortcodes ## Shortcodes
@@ -379,26 +395,33 @@ Use a single newline to separate block-level content like headings, lists, image
### Headings ### Headings
People accessing this documentation may use a screen reader or other assistive technology (AT). [Screen readers](https://en.wikipedia.org/wiki/Screen_reader) are linear output devices, they output items on a page one at a time. If there is a lot of content on a page, you can use headings to give the page an internal structure. A good page structure helps all readers to easily navigate the page or filter topics of interest. People accessing this documentation may use a screen reader or other assistive technology (AT). [Screen readers](https://en.wikipedia.org/wiki/Screen_reader) are linear output devices, they output items on a page one at a time. If there is a lot of content on a page, you can use headings to give the page an internal structure. A good page structure helps all readers to easily navigate the page or filter topics of interest.
<table> {{< table caption = "Do and Don't - Headings" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>Update the title in the front matter of the page or blog post.</td><td>Use first level heading, as Hugo automatically converts the title in the front matter of the page into a first-level heading.</td></tr><tr><td>Use ordered headings to provide a meaningful high-level outline of your content.</td><td>Use headings level 4 through 6, unless it is absolutely necessary. If your content is that detailed, it may need to be broken into separate articles.</td> :--| :-----
<tr><td>Use pound or hash signs (#) for non-blog post content.</td><td> Use underlines (--- or ===) to designate first-level headings.</td></tr> Update the title in the front matter of the page or blog post. | Use first level heading, as Hugo automatically converts the title in the front matter of the page into a first-level heading.
<tr><td>Use sentence case for headings. For example, <b>Extend kubectl with plugins</b></td><td>Use title case for headings. For example, <b>Extend Kubectl With Plugins</b></td></tr> Use ordered headings to provide a meaningful high-level outline of your content. | Use headings level 4 through 6, unless it is absolutely necessary. If your content is that detailed, it may need to be broken into separate articles.
</table> Use pound or hash signs (#) for non-blog post content. | Use underlines (--- or ===) to designate first-level headings.
Use sentence case for headings. For example, **Extend kubectl with plugins** | Use title case for headings. For example, **Extend Kubectl With Plugins**
{{< /table >}}
### Paragraphs ### Paragraphs
<table> {{< table caption = "Do and Don't - Paragraphs" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>Try to keep paragraphs under 6 sentences.</td><td>Indent the first paragraph with space characters. For example, ⋅⋅⋅Three spaces before a paragraph will indent it.</td></tr> :--| :-----
<tr><td>Use three hyphens (---) to create a horizontal rule. Use horizontal rules for breaks in paragraph content. For example, a change of scene in a story, or a shift of topic within a section.</td><td>Use horizontal rules for decoration.</td></tr> Try to keep paragraphs under 6 sentences. | Indent the first paragraph with space characters. For example, ⋅⋅⋅Three spaces before a paragraph will indent it.
</table> Use three hyphens (---) to create a horizontal rule. Use horizontal rules for breaks in paragraph content. For example, a change of scene in a story, or a shift of topic within a section. | Use horizontal rules for decoration.
{{< /table >}}
### Links ### Links
<table>
<tr><th>Do</th><th>Don't</th></tr> {{< table caption = "Do and Don't - Links" >}}
<tr><td>Write hyperlinks that give you context for the content they link to. For example: Certain ports are open on your machines. See <a href="#check-required-ports">Check required ports</a> for more details.</td><td>Use ambiguous terms such as “click here”. For example: Certain ports are open on your machines. See <a href="#check-required-ports">here</a> for more details.</td></tr> <tr><td>Write Markdown-style links &lpar;&lsqb;link text&rsqb;&lpar;URL&rpar;&rpar;. For example, <code>&lsqb;Hugo shortcodes&rsqb;&lpar;/docs/contribute/style/hugo-shortcodes/#table-captions&rpar;</code> and the output is <a href="/docs/contribute/style/hugo-shortcodes/#table-captions">Hugo shortcodes.</td><td>Write HTML-style links <code>&lpar;&lt;link href="/media/examples/link-element-example.css" target="_blank"&gt;Visit our tutorial!&rpar;</code> or create links that open in new tabs or windows. For example, <code>&lsqb;example website&rsqb;&lpar;https://example.com&rpar;{target="_blank"}</code></td></tr> Do | Don't
</table> :--| :-----
Write hyperlinks that give you context for the content they link to. For example: Certain ports are open on your machines. See <a href="#check-required-ports">Check required ports</a> for more details. | Use ambiguous terms such as “click here”. For example: Certain ports are open on your machines. See <a href="#check-required-ports">here</a> for more details.
Write Markdown-style links: `[link text](URL)`. For example: `[Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/#table-captions)` and the output is [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/#table-captions). | Write HTML-style links: `<a href="/media/examples/link-element-example.css" target="_blank">Visit our tutorial!</a>`, or create links that open in new tabs or windows. For example: `[example website](https://example.com){target="_blank"}`
{{< /table >}}
### Lists ### Lists
Group items in a list that are related to each other and need to appear in a specific order or to indicate a correlation between multiple items. When a screen reader comes across a list—whether it is an ordered or unordered list—it will be announced to the user that there is a group of list items. The user can then use the arrow keys to move up and down between the various items in the list. Group items in a list that are related to each other and need to appear in a specific order or to indicate a correlation between multiple items. When a screen reader comes across a list—whether it is an ordered or unordered list—it will be announced to the user that there is a group of list items. The user can then use the arrow keys to move up and down between the various items in the list.
@@ -430,21 +453,25 @@ This section contains suggested best practices for clear, concise, and consisten
### Use present tense ### Use present tense
<table> {{< table caption = "Do and Don't - Use present tense" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>This command starts a proxy.</td><td>This command will start a proxy.</td></tr> :--| :-----
</table> This command starts a proxy. | This command will start a proxy.
{{< /table >}}
Exception: Use future or past tense if it is required to convey the correct Exception: Use future or past tense if it is required to convey the correct
meaning. meaning.
### Use active voice ### Use active voice
<table> {{< table caption = "Do and Don't - Use active voice" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>You can explore the API using a browser.</td><td>The API can be explored using a browser.</td></tr> :--| :-----
<tr><td>The YAML file specifies the replica count.</td><td>The replica count is specified in the YAML file.</td></tr> You can explore the API using a browser. | The API can be explored using a browser.
</table> The YAML file specifies the replica count. | The replica count is specified in the YAML file.
{{< /table >}}
Exception: Use passive voice if active voice leads to an awkward construction. Exception: Use passive voice if active voice leads to an awkward construction.
@@ -452,31 +479,35 @@ Exception: Use passive voice if active voice leads to an awkward construction.
Use simple and direct language. Avoid using unnecessary phrases, such as saying "please." Use simple and direct language. Avoid using unnecessary phrases, such as saying "please."
<table> {{< table caption = "Do and Don't - Use simple and direct language" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>To create a ReplicaSet, ...</td><td>In order to create a ReplicaSet, ...</td></tr> :--| :-----
<tr><td>See the configuration file.</td><td>Please see the configuration file.</td></tr> To create a ReplicaSet, ... | In order to create a ReplicaSet, ...
<tr><td>View the Pods.</td><td>With this next command, we'll view the Pods.</td></tr> See the configuration file. | Please see the configuration file.
View the Pods. | With this next command, we'll view the Pods.
</table> {{< /table >}}
### Address the reader as "you" ### Address the reader as "you"
<table> {{< table caption = "Do and Don't - Addressing the reader" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>You can create a Deployment by ...</td><td>We'll create a Deployment by ...</td></tr> :--| :-----
<tr><td>In the preceding output, you can see...</td><td>In the preceding output, we can see ...</td></tr> You can create a Deployment by ... | We'll create a Deployment by ...
</table> In the preceding output, you can see... | In the preceding output, we can see ...
{{< /table >}}
### Avoid Latin phrases ### Avoid Latin phrases
Prefer English terms over Latin abbreviations. Prefer English terms over Latin abbreviations.
<table> {{< table caption = "Do and Don't - Avoid Latin phrases" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>For example, ...</td><td>e.g., ...</td></tr> :--| :-----
<tr><td>That is, ...</td><td>i.e., ...</td></tr> For example, ... | e.g., ...
</table> That is, ...| i.e., ...
{{< /table >}}
Exception: Use "etc." for et cetera. Exception: Use "etc." for et cetera.
@@ -487,22 +518,26 @@ Exception: Use "etc." for et cetera.
Using "we" in a sentence can be confusing, because the reader might not know Using "we" in a sentence can be confusing, because the reader might not know
whether they're part of the "we" you're describing. whether they're part of the "we" you're describing.
<table> {{< table caption = "Do and Don't - Patterns to avoid" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>Version 1.4 includes ...</td><td>In version 1.4, we have added ...</td></tr> :--| :-----
<tr><td>Kubernetes provides a new feature for ...</td><td>We provide a new feature ...</td></tr> Version 1.4 includes ... | In version 1.4, we have added ...
<tr><td>This page teaches you how to use Pods.</td><td>In this page, we are going to learn about Pods.</td></tr> Kubernetes provides a new feature for ... | We provide a new feature ...
</table> This page teaches you how to use Pods. | In this page, we are going to learn about Pods.
{{< /table >}}
### Avoid jargon and idioms ### Avoid jargon and idioms
Some readers speak English as a second language. Avoid jargon and idioms to help them understand better. Some readers speak English as a second language. Avoid jargon and idioms to help them understand better.
<table> {{< table caption = "Do and Don't - Avoid jargon and idioms" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>Internally, ...</td><td>Under the hood, ...</td></tr> :--| :-----
<tr><td>Create a new cluster.</td><td>Turn up a new cluster.</td></tr> Internally, ... | Under the hood, ...
</table> Create a new cluster. | Turn up a new cluster.
{{< /table >}}
### Avoid statements about the future ### Avoid statements about the future
@@ -515,11 +550,13 @@ information.
Avoid words like "currently" and "new." A feature that is new today might not be Avoid words like "currently" and "new." A feature that is new today might not be
considered new in a few months. considered new in a few months.
<table> {{< table caption = "Do and Don't - Avoid statements that will soon be out of date" >}}
<tr><th>Do</th><th>Don't</th></tr> Do | Don't
<tr><td>In version 1.4, ...</td><td>In the current version, ...</td></tr> :--| :-----
<tr><td>The Federation feature provides ...</td><td>The new Federation feature provides ...</td></tr> In version 1.4, ... | In the current version, ...
</table> The Federation feature provides ... | The new Federation feature provides ...
{{< /table >}}
{{% /capture %}} {{% /capture %}}
content/en/docs/contribute/style/write-new-topic.md
+7 -18
View File
@@ -19,24 +19,13 @@ Create a fork of the Kubernetes documentation repository as described in
As you prepare to write a new topic, think about the page type that would fit your content the best: As you prepare to write a new topic, think about the page type that would fit your content the best:
<table> {{< table caption = "Guidelines for choosing a page type" >}}
Type | Description
<tr> :--- | :----------
<td>Concept</td> 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 plays as an application while it is deployed, scaled, and updated. Typically, concept pages don't include sequences of steps, but instead provide links to tasks or tutorials. For an example of a concept topic, see <a href="/docs/concepts/architecture/nodes/">Nodes</a>.
<td>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 while it is deployed, scaled, and updated. Typically, concept pages don't include sequences of steps, but instead provide links to tasks or tutorials. For an example of a concept topic, see <a href="/docs/concepts/architecture/nodes/">Nodes</a>.</td> Task | A task page shows how to do a single thing. The idea is to give readers a sequence of steps that they can actually do as they read the page. A task page can be short or long, provided it stays focused on one area. In a task page, it is OK to blend brief explanations with the steps to be performed, but if you need to provide a lengthy explanation, you should do that in a concept topic. Related task and concept topics should link to each other. For an example of a short task page, see <a href="/docs/tasks/configure-pod-container/configure-volume-storage/">Configure a Pod to Use a Volume for Storage</a>. For an example of a longer task page, see <a href="/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/">Configure Liveness and Readiness Probes</a>
</tr> Tutorial | A tutorial page shows how to accomplish a goal that ties together several Kubernetes features. A tutorial might provide several sequences of steps that readers can actually do as they read the page. Or it might provide explanations of related pieces of code. For example, a tutorial could provide a walkthrough of a code sample. A tutorial can include brief explanations of the Kubernetes features that are being tied together, but should link to related concept topics for deep explanations of individual features.
{{< /table >}}
<tr>
<td>Task</td>
<td>A task page shows how to do a single thing. The idea is to give readers a sequence of steps that they can actually do as they read the page. A task page can be short or long, provided it stays focused on one area. In a task page, it is OK to blend brief explanations with the steps to be performed, but if you need to provide a lengthy explanation, you should do that in a concept topic. Related task and concept topics should link to each other. For an example of a short task page, see <a href="/docs/tasks/configure-pod-container/configure-volume-storage/">Configure a Pod to Use a Volume for Storage</a>. For an example of a longer task page, see <a href="/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/">Configure Liveness and Readiness Probes</a></td>
</tr>
<tr>
<td>Tutorial</td>
<td>A tutorial page shows how to accomplish a goal that ties together several Kubernetes features. A tutorial might provide several sequences of steps that readers can actually do as they read the page. Or it might provide explanations of related pieces of code. For example, a tutorial could provide a walkthrough of a code sample. A tutorial can include brief explanations of the Kubernetes features that are being tied together, but should link to related concept topics for deep explanations of individual features.</td>
</tr>
</table>
Use a template for each new page. Each page type has a Use a template for each new page. Each page type has a
[template](/docs/contribute/style/page-templates/) [template](/docs/contribute/style/page-templates/)