2019-08-27 00:56:39 +00:00
---
title: Documentation Content Guide
linktitle: Content guide
2020-05-30 19:10:23 +00:00
content_type: concept
2019-08-27 00:56:39 +00:00
weight: 10
---
2020-05-30 19:10:23 +00:00
<!-- overview -->
2019-08-27 00:56:39 +00:00
2020-03-17 22:45:25 +00:00
This page contains guidelines for Kubernetes documentation.
2020-07-05 13:42:13 +00:00
If you have questions about what's allowed, join the #sig -docs channel in
2020-07-17 04:07:19 +00:00
[Kubernetes Slack ](https://slack.k8s.io/ ) and ask!
2020-03-17 22:45:25 +00:00
2020-07-17 04:07:19 +00:00
You can register for Kubernetes Slack at https://slack.k8s.io/.
2020-03-17 22:45:25 +00:00
For information on creating new content for the Kubernetes
docs, follow the [style guide ](/docs/contribute/style/style-guide ).
2019-08-27 00:56:39 +00:00
2020-05-30 19:10:23 +00:00
<!-- body -->
2019-08-27 00:56:39 +00:00
2020-03-17 22:45:25 +00:00
## Overview
Source for the Kubernetes website, including the docs, resides in the
[kubernetes/website ](https://github.com/kubernetes/website ) repository.
2019-12-20 14:49:32 +00:00
Located in the `kubernetes/website/content/<language_code>/docs` folder, the
2020-03-17 22:45:25 +00:00
majority of Kubernetes documentation is specific to the [Kubernetes
2020-07-05 13:42:13 +00:00
project](https://github.com/kubernetes/kubernetes).
2020-03-17 22:45:25 +00:00
## What's allowed
2020-05-28 21:01:43 +00:00
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
- Content is canonical on kubernetes.io, or links to canonical content elsewhere
2020-03-17 22:45:25 +00:00
### Third party content
2020-05-28 21:01:43 +00:00
2020-04-02 13:06:06 +00:00
Kubernetes documentation includes applied examples of projects in the Kubernetes project— projects that live in the [kubernetes ](https://github.com/kubernetes ) and
2020-07-05 13:42:13 +00:00
[kubernetes-sigs ](https://github.com/kubernetes-sigs ) GitHub organizations.
2020-03-17 22:45:25 +00:00
2020-07-05 13:42:13 +00:00
Links to active content in the Kubernetes project are always allowed.
2020-03-17 22:45:25 +00:00
2020-07-05 13:42:13 +00:00
Kubernetes requires some third party content to function. Examples include container runtimes (containerd, CRI-O, Docker),
[networking policy ](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/ ) (CNI plugins), [Ingress controllers ](/docs/concepts/services-networking/ingress-controllers/ ), and [logging ](/docs/concepts/cluster-administration/logging/ ).
2020-03-17 22:45:25 +00:00
2020-05-28 21:01:43 +00:00
Docs can link to third-party open source software (OSS) outside the Kubernetes project only if it's necessary for Kubernetes to function.
2020-03-17 22:45:25 +00:00
### Dual sourced content
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 > }}
2020-07-05 13:42:13 +00:00
If you're a maintainer for a Kubernetes project and need help hosting your own docs,
2020-03-17 22:45:25 +00:00
ask for help in [#sig-docs on Kubernetes Slack ](https://kubernetes.slack.com/messages/C1J0BPD2M/ ).
{{< / note > }}
### More information
2019-08-27 00:56:39 +00:00
2020-07-17 04:07:19 +00:00
If you have questions about allowed content, join the [Kubernetes Slack ](https://slack.k8s.io/ ) #sig -docs channel and ask!
2020-03-17 22:45:25 +00:00
2019-08-27 00:56:39 +00:00
2020-05-30 19:10:23 +00:00
## {{% heading "whatsnext" %}}
2020-03-17 22:45:25 +00:00
2019-08-27 00:56:39 +00:00
* Read the [Style guide ](/docs/contribute/style/style-guide ).
