Skip to content

Commit c9d9e1b

Browse files
aimeeuk8s-ci-robot
authored andcommitted
Add Content Guide to clarify allowed content (#15892)
Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <[email protected]>
1 parent d2ced66 commit c9d9e1b

File tree

4 files changed

+133
-5
lines changed

4 files changed

+133
-5
lines changed

content/en/docs/contribute/intermediate.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ yourself, but the project is better in the long term when we have a diversity of
6262
active participants.
6363

6464
Before you start reviewing PRs, make sure you are familiar with the
65-
[Documentation Style Guide](/docs/contribute/style/style-guide/)
65+
[Documentation Content Guide](/docs/contribute/style/content-guide/), the
66+
[Documentation Style Guide](/docs/contribute/style/style-guide/),
6667
and the [code of conduct](/community/code-of-conduct/).
6768

6869
### Find a PR to review

content/en/docs/contribute/start.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,15 @@ called SIG Docs. We [communicate](#participate-in-sig-docs-discussions) using a
4444
weekly video meetings. New participants are welcome. For more information, see
4545
[Participating in SIG Docs](/docs/contribute/participating/).
4646

47+
### Content guildelines
48+
49+
The SIG Docs community created guidelines about what kind of content is allowed
50+
in the Kubernetes documentation. Look over the [Documentation Content
51+
Guide](/docs/contribute/style/content-guide/) to determine if the content
52+
contribution you want to make is allowed. You can ask questions about allowed
53+
content in the [#sig-docs]((#participate-in-sig-docs-discussions)) Slack
54+
channel.
55+
4756
### Style guidelines
4857

4958
We maintain a [style guide](/docs/contribute/style/style-guide/) with information
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: Documentation Content Guide
3+
linktitle: Content guide
4+
content_template: templates/concept
5+
weight: 10
6+
card:
7+
name: contribute
8+
weight: 20
9+
title: Documentation Content Guide
10+
---
11+
12+
{{% capture overview %}}
13+
This page contains guidelines for adding content to the Kubernetes documentation.
14+
If you have questions about allowed content, join the [Kubernetes Slack](http://slack.k8s.io/) #sig-docs channel and ask! Use your best judgment, and feel free to
15+
propose changes to this document in a pull request.
16+
17+
For additional information on creating new content for the Kubernetes
18+
docs, follow the instructions in the [Style guide](/docs/contribute/style/style-guide).
19+
{{% /capture %}}
20+
21+
{{% capture body %}}
22+
## Contributing content
23+
24+
The Kubernetes documentation comprises the content of the
25+
[kubernetes/website](https://github.com/kubernetes/website) source repository.
26+
Located in the `kubernetes/website/content/<language_code>/docs` folder, the
27+
majority of the Kubernetes documentation is specific to the [Kubernetes
28+
project](https://github.com/kubernetes/kubernetes). The Kubernetes
29+
documentation may also include content from projects in the
30+
[kubernetes](https://github.com/kubernetes) and
31+
[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizations if
32+
those projects do not have their own documentation. Linking to active kubernetes,
33+
kubernetes-sigs, and ({{< glossary_tooltip text="CNCF" term_id="cncf" >}}) projects from the Kubernetes documentation is always
34+
allowed, but linking to vendor-specific products is not. Check the CNCF project lists
35+
([Graduated/Incubating](https://www.cncf.io/projects/),
36+
[Sandbox](https://www.cncf.io/sandbox-projects/),
37+
[Archived](https://www.cncf.io/archived-projects/)) if you are unsure of a
38+
project's CNCF status.
39+
40+
### Dual-sourced content
41+
42+
Kubernetes documentation does not include duplicate content sourced from multiple
43+
locations (*dual-sourced* content). Dual-sourced content requires duplicated
44+
effort from project maintainers and tends to become outdated more quickly.
45+
Before adding content, ask yourself this:
46+
47+
- Is the content about an active CNCF project OR a project in the kubernetes or kubernetes-sigs GitHub organizations?
48+
- If yes, then:
49+
- Does the project have its own documentation?
50+
- if yes, link to the project's documention from the Kubernetes documentation
51+
- if no, add the content to the project's repository if possible and then link to it from the Kubernetes documentation
52+
- If no, then:
53+
- Stop!
54+
- Adding content about vendor-specific products is not allowed
55+
- Linking to vendor-specific documentation and websites is not allowed
56+
57+
### What is and isn't allowed
58+
59+
There are some scenarios in which the Kubernetes documentation includes content from non-Kubernetes projects.
60+
Below are general categories of non-Kubernetes project content along with guidelines of what is and is not allowed:
61+
62+
1. Instructional content involving non-Kubernetes projects during setup or operation of Kubernetes
63+
- Allowed:
64+
- Referring to or linking to existing documentation about a CNCF project or a project in the kubernetes or kubernetes-sigs GitHub organizations
65+
- 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
66+
- Adding content for kubernetes or kubernetes-sigs projects that don't have their own instructional content
67+
- Example: including [kubadm](https://github.com/kubernetes/kubeadm) installation and troubleshooting instructions
68+
- Not Allowed:
69+
- Adding content that duplicates documentation in another repository
70+
- Examples:
71+
- Including minikube installation and configuration instructions; minikube has its own [documentation](https://minikube.sigs.k8s.io/docs/) that provides those instructions
72+
- Including instructions for installing Docker, CRI-O, containerd, and other container runtimes on various operating systems
73+
- Including instructions for installing Kubernetes on production environments using various projects:
74+
- Kubernetes Rebar Integrated Bootstrap (KRIB) is a vendor-specific project and content belongs in the vendor's documentation
75+
- [Kubernetes Operations (kops)](https://github.com/kubernetes/kops) has installation instructions and tutorials in its GitHub repository
76+
- [Kubespray](https://kubespray.io) has its own documenation
77+
- 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
78+
- 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
79+
1. Detailed technical content about how to use a non-Kubernetes project or how that project is designed
80+
81+
Adding this type of content to the Kubernetes documentation is not allowed.
82+
1. Content that describes a non-Kubernetes project
83+
- Allowed:
84+
- 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
85+
- Not Allowed:
86+
- Adding content describing a vendor-specific product
87+
- Adding content describing an open source project that is not a CNCF project or a project in the kubernetes or kubnetes-sigs GitHub organizations
88+
- Adding content that duplicates documentation from another project, regardless of source repository
89+
- Example: adding [Kubernetes in Docker (KinD)](https://kind.sigs.k8s.io) documentation to the Kubernetes documentation
90+
1. Content that simply links to information about a non-Kubernetes project
91+
- Allowed:
92+
- Linking to projects in the kubernetes and kubernetes-sigs GitHub organizations
93+
- Example: linking to Kubernetes in Docker (KinD) [documentation](https://kind.sigs.k8s.io/docs/user/quick-start), which resides in the kubernetes-sigs GitHub organization
94+
- Linking to active CNCF projects
95+
- Example: linking to the Prometheus [documentation](https://prometheus.io/docs/introduction/overview/); Prometheus is an active CNCF project
96+
- Not Allowed:
97+
- Linking to vendor-specific products
98+
- Linking to archived CNCF projects
99+
- Linking to inactive projects in the kubernetes and kubernetes-sigs GitHub organizations
100+
- Linking to open source projects that are not CNCF projects or do not reside in the kubernetes or kubernetes-sigs GitHub organizations
101+
1. Content about training courses
102+
- Allowed:
103+
- Linking to vendor-neutral Kubernetes training courses offered by the [CNCF](https://www.cncf.io/), the [Linux Foundation](https://www.linuxfoundation.org/), and the [Linux Academy](https://linuxacademy.com/), which is a partner of the Linux Foundation
104+
- Example: linking to Linux Academy courses such as [Kubernetes Quick Start](https://linuxacademy.com/course/kubernetes-quick-start/) and [Kubernetes Security](https://linuxacademy.com/course/kubernetes-security/)
105+
- Not Allowed:
106+
- Linking to online training outside of the CNCF, the Linux Foundation, or the Linux Academy; the Kubernetes documentation does not link to third-party content
107+
- Example: linking to Kubernetes tutorials or courses on Medium, KodeKloud, Udacity, Coursera, learnk8s, and similar websites
108+
- Linking to vendor-specific tutorials regardless of the training provider
109+
- Example: linking to Linux Academy courses such as [Google Kubernetes Engine Deep Dive](https://linuxacademy.com/google-cloud-platform/training/course/name/google-kubernetes-engine-deep-dive) and [Amazon EKS Deep Dive](https://linuxacademy.com/course/amazon-eks-deep-dive/)
110+
111+
If you have questions about allowed content, join the [Kubernetes Slack](http://slack.k8s.io/) #sig-docs channel and ask!
112+
{{% /capture %}}
113+
114+
{{% capture whatsnext %}}
115+
* Read the [Style guide](/docs/contribute/style/style-guide).
116+
{{% /capture %}}

content/en/docs/contribute/style/style-guide.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,12 @@ This page gives writing style guidelines for the Kubernetes documentation.
1414
These are guidelines, not rules. Use your best judgment, and feel free to
1515
propose changes to this document in a pull request.
1616

17-
For additional information on creating new content for the Kubernetes
18-
docs, follow the instructions on
19-
[using page templates](/docs/contribute/style/page-templates/) and
20-
[creating a documentation pull request](/docs/contribute/start/#improve-existing-content).
17+
For additional information on creating new content for the Kubernetes
18+
documentation, read the [Documentation Content
19+
Guide](/docs/contribute/style/content-guide/) and follow the instructions on
20+
[using page templates](/docs/contribute/style/page-templates/) and [creating a
21+
documentation pull request](/docs/contribute/start/#improve-existing-content).
22+
2123
{{% /capture %}}
2224

2325
{{% capture body %}}

0 commit comments

Comments
 (0)