Professional Documents
Culture Documents
Documentation
• Blog
• Partners
• Community
• Case Studies
• English
• v1.10
Get Started
Ready to get your hands dirty? Build a simple Kubernetes cluster that runs "Hello
World" for Node.js.
Documentation
Learn how to use Kubernetes with the use of walkthroughs, samples, and
reference documentation. You can even help contribute to the docs!
Community
If you need help, you can connect with other Kubernetes users and the Kubernetes
authors, attend community events, and watch video presentations from around the
web.
Blog
Read the latest news for Kubernetes and the containers space in general, and get
technical how-tos hot off the presses.
View On Github
• DOCUMENTATION
• SETUP
• CONCEPTS
• TASKS
• TUTORIALS
• REFERENCE
Documentation
Supported Versions of the Kubernetes Documentation
Content Organization
Participating in SIG-DOCS
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.
For additional information on creating new content for the Kubernetes docs, follow
the instructions on using page templates and creating a documentation pull
request.
• Language
• Documentation formatting standards
• Inline code formatting
• Code snippet formatting
• Kubernetes.io word list
• Shortcodes
• Common Shortcode Issues
• Content best practices
• Patterns to avoid
• What's next
Note: Kubernetes documentation uses Blackfriday Markdown Renderer along with a
few Hugo Shortcodes to support glossary entries, tabs, and representing feature
state.
Language
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.
Do Don
Set the value of the replicas field in the configuration file. Set t
The value of the exec field is an ExecAction object. The
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:
---
title: <your tutorial title here>
min-kubernetes-server-version: v1.8
---
Shortcodes
Hugo Shortcodes help create different rhetorical appeal levels. Our documentation
supports three different shortcodes in this category: Note: {{< note
>}}, Caution: {{< caution >}}, and Warning: {{< warning >}}.
1. Surround the text with an opening and closing shortcode.
2. Use the following syntax to apply a style:
3. {{< note >}}
4. **Note:**** The prefix you use is the same text you use in the tag.
{{< /note >}}
Note
Use {{< note >}} to highlight a tip or a piece of information that may be helpful to
know.
For example:
{{< note >}}
**Note:** You can _still_ use Markdown inside these callouts.
{{< /note >}}
Caution
Use {{< caution >}} to call attention to an important piece of information to avoid
pitfalls.
For example:
{{< caution >}}
**Caution:** The callout style only applies to the line directly above
the tag.
{{< /caution >}}
Warning
Use {{< warning >}} to indicate danger or a piece of information that is crucial to
follow.
For example:
{{< warning >}}
**Warning:** Beware.
{{< /warning >}}
For example:
1. Preheat oven to 350˚F
This section contains suggested best practices for clear, concise, and consistent
content.
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
Patterns to avoid
What's next