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.
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-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
Archived) if you are unsure of a
project’s CNCF status.
Kubernetes documentation does not include duplicate content sourced from multiple
locations (dual-sourced content). Dual-sourced content requires duplicated
effort from project maintainers and tends to become outdated more quickly.
Before adding content, ask yourself this:
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:
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:
Instructional content involving non-Kubernetes projects during setup or operation of Kubernetes
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
Example: including kubadm installation and troubleshooting instructions
Adding content that duplicates documentation in another repository
Including minikube installation and configuration instructions; minikube has its own documentation that provides those instructions
Including instructions for installing Docker, CRI-O, containerd, and other container runtimes on various operating systems
Including instructions for installing Kubernetes on production environments using various projects:
Kubernetes Rebar Integrated Bootstrap (KRIB) is a vendor-specific project and content belongs in the vendor’s documentation
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
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
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