|
| 1 | +--- |
| 2 | +title: Documentation Content Guide |
| 3 | +linktitle: Content guide |
| 4 | +content_type: concept |
| 5 | +weight: 10 |
| 6 | +--- |
| 7 | + |
| 8 | +<!-- overview --> |
| 9 | + |
| 10 | +This page contains guidelines for Kubernetes documentation. |
| 11 | + |
| 12 | +If you have questions about what's allowed, join the #sig-docs channel in |
| 13 | +[Kubernetes Slack](https://slack.k8s.io/) and ask! |
| 14 | + |
| 15 | +You can register for Kubernetes Slack at https://slack.k8s.io/. |
| 16 | + |
| 17 | +For information on creating new content for the Kubernetes |
| 18 | +docs, follow the [style guide](/docs/contribute/style/style-guide). |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +<!-- body --> |
| 23 | + |
| 24 | +## Overview |
| 25 | + |
| 26 | +Source for the Kubernetes website, including the docs, resides in the |
| 27 | +[kubernetes/website](https://github.com/kubernetes/website) repository. |
| 28 | + |
| 29 | +Located in the `kubernetes/website/content/<language_code>/docs` folder, the |
| 30 | +majority of Kubernetes documentation is specific to the [Kubernetes |
| 31 | +project](https://github.com/kubernetes/kubernetes). |
| 32 | + |
| 33 | +## What's allowed |
| 34 | + |
| 35 | +Kubernetes docs allow content for third-party projects only when: |
| 36 | + |
| 37 | +- Content documents software in the Kubernetes project |
| 38 | +- Content documents software that's out of project but necessary for Kubernetes to function |
| 39 | +- Content is canonical on kubernetes.io, or links to canonical content elsewhere |
| 40 | + |
| 41 | +### Third party content |
| 42 | + |
| 43 | +Kubernetes documentation includes applied examples of projects in the Kubernetes project—projects that live in the [kubernetes](https://github.com/kubernetes) and |
| 44 | +[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizations. |
| 45 | + |
| 46 | +Links to active content in the Kubernetes project are always allowed. |
| 47 | + |
| 48 | +Kubernetes requires some third party content to function. Examples include container runtimes (containerd, CRI-O, Docker), |
| 49 | +[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/). |
| 50 | + |
| 51 | +Docs can link to third-party open source software (OSS) outside the Kubernetes project only if it's necessary for Kubernetes to function. |
| 52 | + |
| 53 | +### Dual sourced content |
| 54 | + |
| 55 | +Wherever possible, Kubernetes docs link to canonical sources instead of hosting |
| 56 | +dual-sourced content. |
| 57 | + |
| 58 | +Dual-sourced content requires double the effort (or more!) to maintain |
| 59 | +and grows stale more quickly. |
| 60 | + |
| 61 | +{{< note >}} |
| 62 | + |
| 63 | +If you're a maintainer for a Kubernetes project and need help hosting your own docs, |
| 64 | +ask for help in [#sig-docs on Kubernetes Slack](https://kubernetes.slack.com/messages/C1J0BPD2M/). |
| 65 | + |
| 66 | +{{< /note >}} |
| 67 | + |
| 68 | +### More information |
| 69 | + |
| 70 | +If you have questions about allowed content, join the [Kubernetes Slack](https://slack.k8s.io/) #sig-docs channel and ask! |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | +## {{% heading "whatsnext" %}} |
| 75 | + |
| 76 | + |
| 77 | +* Read the [Style guide](/docs/contribute/style/style-guide). |
0 commit comments