Skip to content

Commit c65972b

Browse files
author
zacharysarah
committed
Feedback from dims, derekwaynecarr, cblecker
1 parent 9fd3f96 commit c65972b

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

keps/sig-docs/20191020-doc-policies-for-third-party-content.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,6 @@ project docs is to host single-sourced content only, and to provide
8282
links to other providers’ single-sourced content. This simplifies
8383
version management and reduces the work required to maintain content.
8484

85-
This KEP proposes that Kubernetes documentation sets these boundaries:
86-
87-
- Kubernetes documentation includes
88-
8985
This KEP defines how to handle third-party and dual-sourced content in
9086
documentation, so that authors can
9187
judge what is appropriate to propose and so that PR approvers can make
@@ -107,7 +103,7 @@ offerings.
107103
Some third party content is necessary in order for Kubernetes to
108104
function. For example: container runtimes (containerd, CRI-o, Docker),
109105
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/)
111107
are highly specific to a third party offering and seem more like third party
112108
product documentation than Kubernetes open source documentation.
113109

@@ -129,7 +125,7 @@ To address its goal, this KEP focuses on the following issues:
129125
1. What third party content is appropriate for inclusion in the Kubernetes
130126
documentation?
131127

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
133129
function in-project.
134130

135131
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.
153149
up to date or hosts?
154150

155151
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
153+
specifically includes:
154+
155+
- Mailing an initial list of affected pages to [email protected]
156+
- 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
157159

158160
1. Can feature owners flag when third party content is *required*, as opposed to
159161
preferable or common?
@@ -193,24 +195,26 @@ Third-party content should be linked instead of hosted whenever possible.
193195

194196
### Non-Goals
195197

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.
198200

199201
## Proposal
200202

201203
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:
202204

203205
- 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
205207
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
207210
whenever possible, rather than duplicated or hosted in k/website.
208211

209212
2. Revise the documentation when the KEP is approved:
210213

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
216+
content to [email protected] that non-conforming content will be
217+
removed after 90 days.
214218

215219
This limits the impact to out-of-project content and gives current stakeholders
216220
approximately one Kubernetes release cycle to migrate
@@ -219,10 +223,12 @@ Kubernetes docs.
219223

220224
- **Dual-sourced content:** Where sourcing is obvious, replace dual-sourced
221225
content with links to an authoritative single source. Where sourcing is unclear,
222-
notify stakeholders via GitHub issues in k/website that dual-sourced content
226+
notify stakeholders via GitHub issues in k/website and via a single message
227+
containing a summary of all affected content to [email protected]
228+
that non-conforming content will be removed after 90 days.
223229

224230
In all cases where content would be removed, provide adequate time for the
225-
relevant SIG to review changes in content.
231+
relevant SIG to review changes and notify stakeholders.
226232

227233
### User Stories
228234

0 commit comments

Comments
 (0)