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
Copy file name to clipboardExpand all lines: keps/sig-docs/20191020-doc-policies-for-third-party-content.md
+22-16Lines changed: 22 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -82,10 +82,6 @@ project docs is to host single-sourced content only, and to provide
82
82
links to other providers’ single-sourced content. This simplifies
83
83
version management and reduces the work required to maintain content.
84
84
85
-
This KEP proposes that Kubernetes documentation sets these boundaries:
86
-
87
-
- Kubernetes documentation includes
88
-
89
85
This KEP defines how to handle third-party and dual-sourced content in
90
86
documentation, so that authors can
91
87
judge what is appropriate to propose and so that PR approvers can make
@@ -107,7 +103,7 @@ offerings.
107
103
Some third party content is necessary in order for Kubernetes to
108
104
function. For example: container runtimes (containerd, CRI-o, Docker),
109
105
networking policy (CNI plugins), Ingress controllers, and logging all require
110
-
third party components. Pages like [Logging Using Elasticsearch and Kibana](https://kubernetes.io/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana/)
106
+
third party components. Pages like [Logging Using Stackdriver](https://kubernetes.io/docs/tasks/debug-application-cluster/logging-stackdriver/)
111
107
are highly specific to a third party offering and seem more like third party
112
108
product documentation than Kubernetes open source documentation.
113
109
@@ -129,7 +125,7 @@ To address its goal, this KEP focuses on the following issues:
129
125
1. What third party content is appropriate for inclusion in the Kubernetes
130
126
documentation?
131
127
132
-
Proposed: Third-party content is permitted if it's required for Kubernetes to
128
+
Proposed: Third-party content is permitted if it is required for Kubernetes to
133
129
function in-project.
134
130
135
131
1. Does third party content in sections such as [Getting Started](https://kubernetes.io/docs/setup/)
@@ -153,7 +149,13 @@ As infrequently as possible, with linking preferred to hosting.
153
149
up to date or hosts?
154
150
155
151
If content isn't refreshed within 180 days, notify stakeholders of 90 days to
156
-
update content or migrate it elsewhere before removing it.
152
+
update content or migrate it elsewhere before removing it. Notification
- Announcing the policy change in two Kubernetes community meetings in a row
157
+
- Posting a notification of the policy change on the Kubernetes blog
158
+
- Notifying SIG PR review aliases on GitHub in PRs that remove affected content
157
159
158
160
1. Can feature owners flag when third party content is *required*, as opposed to
159
161
preferable or common?
@@ -193,24 +195,26 @@ Third-party content should be linked instead of hosted whenever possible.
193
195
194
196
### Non-Goals
195
197
196
-
1. Outright removal of all content relating to vendors and projects
197
-
outside the CNCF ecosystem.
198
+
1. Outright removal of all content relating to vendors and projects outside the
199
+
Kubernetes project.
198
200
199
201
## Proposal
200
202
201
203
1. Revise the [content guide](https://github.com/kubernetes/website/blob/master/content/en/docs/contribute/style/content-guide.md#contributing-content) to achieve the KEP goal:
202
204
203
205
- Specify that Kubernetes docs are limited to content required for Kubernetes to
204
-
function in-project. Docs may include third-party content for components that
206
+
function in-project. Docs may include third-party OSS content for components that
205
207
require a third-party solution to function. Docs may include content for
206
-
other projects in the Kubernetes org. Third-party content must be linked
208
+
other projects in the Kubernetes org, and content from other OSS projects that
209
+
are necessary for Kubernetes to function. Third-party content must be linked
207
210
whenever possible, rather than duplicated or hosted in k/website.
208
211
209
212
2. Revise the documentation when the KEP is approved:
210
213
211
-
-**Third-party content:** Notify stakeholders via GitHub issues in k/website
212
-
that third-party content will be removed after 90 days if content isn't required
213
-
for Kubernetes to function in-project.
214
+
-**Third-party content:** Notify stakeholders of all affected content via
215
+
GitHub issues and via a single message containing a summary of all affected
0 commit comments