This page gives writing style guidelines for the Kubernetes documentation. These are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
When you refer to an API object, use the same uppercase and lowercase letters that are used in the actual object name. Typically, the names of API objects use camel case.
Don’t split the API object name into separate words. For example, use PodTemplateList, not Pod Template List.
Refer to API objects without saying “object,” unless omitting “object” leads to an awkward construction.
|The Pod has two Containers.||The pod has two containers.|
|The Deployment is responsible for ...||The Deployment object is responsible for ...|
|A PodList is a list of Pods.||A Pod List is a list of pods.|
|The two ContainerPorts ...||The two ContainerPort objects ...|
|The two ContainerStateTerminated objects ...||The two ContainerStateTerminateds ...|
Use angle brackets for placeholders. Tell the reader what a placeholder represents.
Display information about a pod:
kubectl describe pod <pod-name>
<pod-name> is the name of one of your pods.
|Click Fork.||Click "Fork".|
|Select Other.||Select 'Other'.|
|A cluster is a set of nodes ...||A "cluster" is a set of nodes ...|
|These components form the control plane.||These components form the control plane.|
|Open the ||Open the envars.yaml file.|
|Go to the ||Go to the /docs/tutorials directory.|
|Open the ||Open the /_data/concepts.yaml file.|
For inline code in an HTML document, use the
<code> tag. In a Markdown
document, use the backtick (`).
|Set the value of the ||Set the value of the "replicas" field in the configuration file.|
|The ||The "kubectl run" command creates a Deployment.|
|kubectl get pods||$ kubectl get pods|
Verify that the pod is running on your chosen node:
kubectl get pods --output=wide
The output is similar to this:
NAME READY STATUS RESTARTS AGE IP NODE nginx 1/1 Running 0 13s 10.200.0.4 worker0
This section contains suggested best practices for clear, concise, and consistent content.
|This command starts a proxy.||This command will start a proxy.|
Exception: Use future or past tense if it is required to convey the correct meaning.
|You can explore the API using a browser.||The API can be explored using a browser.|
|The YAML file specifies the replica count.||The replica count is specified in the YAML file.|
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.”
|To create a ReplicaSet, ...||In order to create a ReplicaSet, ...|
|See the configuration file.||Please see the configuration file.|
|View the Pods.||With this next command, we'll view the Pods.|
|You can create a Deployment by ...||We'll create a Deployment by ...|
|In the preceding output, you can see...||In the preceding output, we can see ...|
Using “we” in a sentence can be confusing, because the reader might not know whether they’re part of the “we” you’re describing.
|Version 1.4 includes ...||In version 1.4, we have added ...|
|Kubernetes provides a new feature for ...||We provide a new feature ...|
|This page teaches you how to use pods.||In this page, we are going to learn about pods.|
Some readers speak English as a second language. Avoid jargon and idioms to help make their understanding easier.
|Internally, ...||Under the hood, ...|
|Create a new cluster.||Turn up a new cluster.|
Avoid making promises or giving hints about the future. If you need to talk about an alpha feature, put the text under a heading that identifies it as alpha information.
Avoid words like “currently” and “new.” A feature that is new today might not be considered new in a few months.
|In version 1.4, ...||In the current version, ...|
|The Federation feature provides ...||The new Federation feature provides ...|