Kubernetes v1.16
documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the
latest version.

Documentation Content Guide

This page contains guidelines for adding content to the Kubernetes documentation.
If you have questions about allowed content, join the Kubernetes Slack #sig-docs channel and ask! 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 in the Style guide.

Contributing content

The Kubernetes documentation comprises the content of the
kubernetes/website source repository.
Located in the kubernetes/website/content/<language_code>/docs folder, the
majority of the Kubernetes documentation is specific to the Kubernetes
project. The Kubernetes
documentation may also include content from projects in the
kubernetes and
kubernetes-sigs GitHub organizations if
those projects do not have their own documentation. Linking to active kubernetes,
kubernetes-sigs, and (CNCFCloud Native Computing Foundation) projects from the Kubernetes documentation is always
allowed, but linking to vendor-specific products is not. Check the CNCF project lists
(Graduated/Incubating,
Sandbox,
Archived) if you are unsure of a
project’s CNCF status.

Is the content about an active CNCF project OR a project in the kubernetes or kubernetes-sigs GitHub organizations?

If yes, then:

Does the project have its own documentation?

if yes, link to the project’s documention from the Kubernetes documentation

if no, add the content to the project’s repository if possible and then link to it from the Kubernetes documentation

If no, then:

Stop!

Adding content about vendor-specific products is not allowed

Linking to vendor-specific documentation and websites is not allowed

What is and isn’t allowed

There are some scenarios in which the Kubernetes documentation includes content from non-Kubernetes projects.
Below are general categories of non-Kubernetes project content along with guidelines of what is and is not allowed:

Referring to or linking to existing documentation about a CNCF project or a project in the kubernetes or kubernetes-sigs GitHub organizations

Example: for installating Kubernetes in a learning environment, including a prerequisite stating that successful installation and configuration of minikube is required and linking to the relevant minikube documentation

Adding content for kubernetes or kubernetes-sigs projects that don’t have their own instructional content

Adding a tutorial that explains how to perform a task using a vendor-specific product or an open source project that is not a CNCF project or a project in the kubernetes or kubnetes-sigs GitHub organizations

Adding a tutorial on how to use a CNCF project or a project in the kubernetes or kubnetes-sigs GitHub organizations if the project has its own documentation

Detailed technical content about how to use a non-Kubernetes project or how that project is designed

Adding this type of content to the Kubernetes documentation is not allowed.

Content that describes a non-Kubernetes project

Allowed:

Adding a brief introductory paragraph about a CNCF project or a project in the kubernetes or kubernetes-sigs GitHub organizations; the paragraph may contain links to the project

Not Allowed:

Adding content describing a vendor-specific product

Adding content describing an open source project that is not a CNCF project or a project in the kubernetes or kubnetes-sigs GitHub organizations

Adding content that duplicates documentation from another project, regardless of source repository