Versioning howto (#7400)
* whitespace cleanup * adding word list since it keeps appearing in reviews... * initial draft based on feb13,2018 docs meeting conversation * nits
This commit is contained in:
committed by
k8s-ci-robot
parent
c5a897c94e
commit
ef6c7d8517
@@ -18,12 +18,10 @@ docs, follow the instructions on
|
|||||||
**Note:** Kubernetes documentation uses [GitHub Flavored Markdown](https://github.github.com/gfm/).
|
**Note:** Kubernetes documentation uses [GitHub Flavored Markdown](https://github.github.com/gfm/).
|
||||||
{: .note}
|
{: .note}
|
||||||
|
|
||||||
|
|
||||||
## Language
|
## Language
|
||||||
|
|
||||||
Kubernetes documentation uses US English.
|
Kubernetes documentation uses US English.
|
||||||
|
|
||||||
|
|
||||||
## Documentation formatting standards
|
## Documentation formatting standards
|
||||||
|
|
||||||
### Use camel case for API objects
|
### Use camel case for API objects
|
||||||
@@ -144,15 +142,47 @@ The output is similar to this:
|
|||||||
NAME READY STATUS RESTARTS AGE IP NODE
|
NAME READY STATUS RESTARTS AGE IP NODE
|
||||||
nginx 1/1 Running 0 13s 10.200.0.4 worker0
|
nginx 1/1 Running 0 13s 10.200.0.4 worker0
|
||||||
|
|
||||||
|
### Versioning Kubernetes examples
|
||||||
|
|
||||||
{% comment %}## Kubernetes.io word list
|
Code examples and configuration examples that include version information should be consistent with the accompanying text. Identify the Kubernetes version in the **Before you begin** section.
|
||||||
|
|
||||||
|
To specify the Kubernetes version for a task or tutorial page:
|
||||||
|
|
||||||
|
- Include `min-kubernetes-server-version` in the front matter of the page.
|
||||||
|
- In the **Before you begin** section, use `{{ "{% include tasks-tutorial-prereqs.md "}} %}`.
|
||||||
|
|
||||||
|
If the example YAML is in a standalone file, find and review the topics that include it as a reference.
|
||||||
|
Verify that any topics using the standalone YAML have the appropriate version information defined.
|
||||||
|
If a stand-alone YAML file is not referenced from any topics, consider deleting it instead of updating it.
|
||||||
|
|
||||||
|
For example, if you are writing a tutorial that is relevant to Kubernetes version 1.8, the front-matter of your markdown file should look something like:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
title: <your tutorial title here>
|
||||||
|
min-kubernetes-server-version: v1.8
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
|
In code and configuration examples, do not include comments about alternative versions.
|
||||||
|
Be careful to not include incorrect statements in your examples as comments, such as:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
apiVersion: v1 # earlier versions use...
|
||||||
|
kind: Pod
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
## Kubernetes.io word list
|
||||||
|
|
||||||
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>
|
||||||
<tr><th>Term</th><th>Usage</th></tr>
|
<tr><th>Term</th><th>Usage</th></tr>
|
||||||
<tr><td>TBD</td><td>TBD</td></tr>
|
<tr><td>Kubernetes</td><td>Kubernetes should always be capitalized.</td></tr>
|
||||||
</table>{% endcomment %}
|
<tr><td>Docker</td><td>Docker should always be capitalized.</td></tr>
|
||||||
|
<tr><td>SIG Docs</td><td>SIG Docs rather than SIG-DOCS or other variations.</td></tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
## Callout Formatting
|
## Callout Formatting
|
||||||
Callouts help create different rhetorical appeal levels. Our documentation supports three different callouts: **Note:** {: .note}, **Caution:** {: .caution}, and **Warning:** {: .warning}.
|
Callouts help create different rhetorical appeal levels. Our documentation supports three different callouts: **Note:** {: .note}, **Caution:** {: .caution}, and **Warning:** {: .warning}.
|
||||||
@@ -272,7 +302,6 @@ The output is:
|
|||||||
|
|
||||||
1. Bake for 20-25 minutes or until set.
|
1. Bake for 20-25 minutes or until set.
|
||||||
|
|
||||||
|
|
||||||
## Content best practices
|
## Content best practices
|
||||||
|
|
||||||
This section contains suggested best practices for clear, concise, and consistent content.
|
This section contains suggested best practices for clear, concise, and consistent content.
|
||||||
@@ -372,12 +401,13 @@ considered new in a few months.
|
|||||||
|
|
||||||
{% endcapture %}
|
{% endcapture %}
|
||||||
|
|
||||||
|
|
||||||
{% capture whatsnext %}
|
{% capture whatsnext %}
|
||||||
|
|
||||||
* Learn about [writing a new topic](/docs/home/contribute/write-new-topic/).
|
* Learn about [writing a new topic](/docs/home/contribute/write-new-topic/).
|
||||||
* Learn about [using page templates](/docs/home/contribute/page-templates/).
|
* Learn about [using page templates](/docs/home/contribute/page-templates/).
|
||||||
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/)
|
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/)
|
||||||
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
|
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
|
||||||
|
|
||||||
{% endcapture %}
|
{% endcapture %}
|
||||||
|
|
||||||
{% include templates/concept.md %}
|
{% include templates/concept.md %}
|
||||||
|
|||||||
Reference in New Issue
Block a user