Documentation Content Guide

If you have questions about what’s allowed, join the #sig-docs channel in Kubernetes Slack and ask!

You can register for Kubernetes Slack at .

For information on creating new content for the Kubernetes docs, follow the style guide.

Source for the Kubernetes website, including the docs, resides in the kubernetes/website repository.

Kubernetes docs allow content for third-party projects only when:

• Content documents software in the Kubernetes project
• Content documents software that’s out of project but necessary for Kubernetes to function

Kubernetes documentation includes applied examples of projects in the Kubernetes project—projects that live in the and kubernetes-sigs GitHub organizations.

Links to active content in the Kubernetes project are always allowed.

Kubernetes requires some third party content to function. Examples include container runtimes (containerd, CRI-O, Docker), (CNI plugins), Ingress controllers, and .

Wherever possible, Kubernetes docs link to canonical sources instead of hosting dual-sourced content.

Dual-sourced content requires double the effort (or more!) to maintain and grows stale more quickly.

Note: If you’re a maintainer for a Kubernetes project and need help hosting your own docs, ask for help in .

If you have questions about allowed content, join the #sig-docs channel and ask!

• Read the .