Documentation

This style guide is adapted from the Kubernetes style guide .

This page outlines writing style guidelines for the Kubeapps documentation. Use this page as a reference as you write or edit content. Note that these are guidelines, not rules. Use your best judgment as you write documentation, and feel free to propose changes to these guidelines.

Exception: Use future or past tense if it is required to convey the correct meaning.

Exception: Use passive voice if active voice leads to an awkward sentence construction.

Use simple and direct language. Avoid using unnecessary phrases, such as saying “please.”

Use English terms instead of Latin abbreviations.

Exception: Use “etc.” for et cetera.

Using “we” in a sentence can be confusing, because the reader might not know whether they’re part of the “we” you’re describing.

Avoid jargon and idioms.

Avoid making promises or giving hints about the future. If you need to talk about a beta feature, put the text under a heading that identifies it as beta information.

Also avoid words like “recently”, “currently” and “new.” A feature that is new today might not be considered new in a few months.

This documentation uses U.S. English spelling and grammar.

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 sentence construction.

Use angle brackets for placeholders that indicate a variable value. Enter a generic name for the variable and use hyphens to separate words. If you think it’s necessary, tell the reader what a placeholder represents.

1. Display information about a Pod:

   kubectl describe pod <POD-NAME> -n <NAMESPACE>
   

Exception: When the quoted word is a user input.

Example:

• My user ID is “IM47g”.
• Did you try the password “mycatisawesome”?

For inline code in an HTML document, use the <code> tag. In a Markdown document, use the backtick (`).

For field values of type string or integer, use normal style without quotation marks.

For example:

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

People accessing this documentation may use a screen reader or other assistive technology (AT). Screen readers 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.

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 reads an ordered or unordered list, it indicates 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. Website navigation links can also be marked up as list items.

• End each item in a list with a period if one or more items in the list are complete sentences. For the sake of consistency, normally either all items or none should be complete sentences.

  • Ordered lists that are part of an incomplete introductory sentence can be in lowercase and punctuated as if each item was a part of the introductory sentence.

• Use the number one (1.) for ordered lists.

• Use (+), (*), or (-) for unordered lists - be consistent within the same document.

• Leave a blank line after each list.

• Indent nested lists with four spaces (for example, ⋅⋅⋅⋅).

• List items may consist of multiple paragraphs. Each subsequent paragraph in a list item must be indented by either four spaces or one tab.

The semantic purpose of a data table is to present tabular data. Sighted users can quickly scan the table but a screen reader goes through line by line. A table caption is used to create a descriptive title for a data table. Assistive technologies (AT) use the HTML table caption element to identify the table contents to the user within the page structure. If you need to create a table, create the table in markdown and (optionally) use the table Hugo shortcode to include a caption.