Don't: Set the value of `imagePullPolicy` to "Always".
_____
Do: Set the value of `image` to nginx:1.8.
Don't: Set the value of `image` to `nginx:1.8`.
_____
Do: Set the value of the `replicas` field to 2.
Don't: Set the value of the `replicas` field to 2.
_____
## Code snippet formatting
### Don’t include the command prompt
Do: yarn start
Don't: $ yarn start
## Content best practices
This section contains suggested best practices for clear, concise, and consistent content.
### Use present tense
Do: This command starts a proxy.
Don't: This command will start a proxy.
Exception: Use future or past tense if it is required to convey the correct meaning.
### Use active voice
Do: You can explore the API using a browser.
Don't: The API can be explored using a browser.
_____
Do: The YAML file specifies the collection name.
Don't: The collection name is specified in the YAML file.
_____
Exception: Use passive voice if active voice leads to an awkward construction.
### Use simple and direct language
Use simple and direct language. Avoid using unnecessary phrases, such as saying “please.”
Do: To create an entry, …
Don't: In order to create an entry, …
_____
Do: See the configuration file.
Don't: Please see the configuration file.
_____
Do: View the fields.
Don't: With this next command, we'll view the fields.
_____
### Address the reader as “you”
Do: You can create a Deployment by …
Don't: We'll create a Deployment by …
_____
Do: In the preceding output, you can see…
Don't: In the preceding output, we can see …
### Avoid Latin phrases
Prefer English terms over Latin abbreviations.
Do: For example, …
Don't: e.g., …
_____
Do: That is, …
Don't: i.e., …
_____
Exception: Use “etc.” for et cetera.
## Patterns to avoid
### Avoid using “we”
Using “we” in a sentence can be confusing, because the reader might not know whether they’re part of the “we” you’re describing.
Do: Version 1.4 includes …
Don't: In version 1.4, we have added …
_____
Do: Simple CMS provides a new feature for …
Don't: We provide a new feature …
_____
Do: This page teaches you how to use Widgets.
Don't: In this page, we are going to learn about Widgets.
_____
### Avoid jargon and idioms
Some readers speak English as a second language. Avoid jargon and idioms to help them understand better.
Do: Internally
Don't: Under the hood, …
_____
Do: Create a new cluster.
Don't: Turn up a new cluster.
_____
### Avoid statements about the future
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 statements that will soon be out of date
Avoid words like “currently” and “new.” A feature that is new today will not be new in a few months.
