You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
KEP 1327: Apply feedback for third party and dual sourced content (kubernetes#19486)
* Apply feedback for third party and dual sourced content
Add feedback from sftim
clarify which slack
* Limit third-party content to OSS
See kubernetes/enhancements#1327 (comment) for more discussion
Copy file name to clipboardExpand all lines: content/en/docs/contribute/style/content-guide.md
+52-91Lines changed: 52 additions & 91 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,107 +10,68 @@ card:
10
10
---
11
11
12
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
13
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).
14
+
This page contains guidelines for Kubernetes documentation.
15
+
16
+
If you have questions about what's allowed, join the #sig-docs channel in
17
+
[Kubernetes Slack](http://slack.k8s.io/) and ask!
18
+
19
+
You can register for Kubernetes Slack at http://slack.k8s.io/.
20
+
21
+
For information on creating new content for the Kubernetes
22
+
docs, follow the [style guide](/docs/contribute/style/style-guide).
23
+
19
24
{{% /capture %}}
20
25
21
26
{{% capture body %}}
22
-
## Contributing content
23
27
24
-
The Kubernetes documentation comprises the content of the
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 documentation 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 [kubeadm](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 documentation
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/)
34
+
majority of Kubernetes documentation is specific to the [Kubernetes
Kubernetes docs permit only some kinds of content.
40
+
41
+
### Third party content
42
+
Kubernetes documentation includes applied examples of projects in the Kubernetes project&emdash;projects that live in the [kubernetes](https://github.com/kubernetes) and
Copy file name to clipboardExpand all lines: content/en/docs/setup/_index.md
+1-58Lines changed: 1 addition & 58 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,63 +53,6 @@ If you're learning Kubernetes, use the Docker-based solutions: tools supported b
53
53
54
54
When evaluating a solution for a production environment, consider which aspects of operating a Kubernetes cluster (or _abstractions_) you want to manage yourself or offload to a provider.
55
55
56
-
Some possible abstractions of a Kubernetes cluster are {{< glossary_tooltip text="applications" term_id="applications" >}}, {{< glossary_tooltip text="data plane" term_id="data-plane" >}}, {{< glossary_tooltip text="control plane" term_id="control-plane" >}}, {{< glossary_tooltip text="cluster infrastructure" term_id="cluster-infrastructure" >}}, and {{< glossary_tooltip text="cluster operations" term_id="cluster-operations" >}}.
57
-
58
-
The following diagram lists the possible abstractions of a Kubernetes cluster and whether an abstraction is self-managed or managed by a provider.
59
-
60
-
Production environment solutions
61
-
62
-
{{< table caption="Production environment solutions table lists the providers and the solutions." >}}
63
-
The following production environment solutions table lists the providers and the solutions that they offer.
|[Oracle Cloud Infrastructure Container Engine for Kubernetes (OKE)](https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengoverview.htm)|✔|✔||||
103
-
|[oVirt](https://www.ovirt.org/)|||||✔|
104
-
|[Pivotal](https://pivotal.io/)||[Enterprise Pivotal Container Service (PKS)](https://pivotal.io/platform/pivotal-container-service)|[Enterprise Pivotal Container Service (PKS)](https://pivotal.io/platform/pivotal-container-service)|||
For a list of [Certified Kubernetes](https://github.com/cncf/k8s-conformance/#certified-kubernetes) providers, see "[Partners](https://kubernetes.io/partners/#conformance)".
0 commit comments