-
Notifications
You must be signed in to change notification settings - Fork 15.4k
Clarify style guide: eliminate most third party content #15576
Copy link
Copy link
Closed
Labels
priority/important-soonMust be staffed and worked on either currently, or very soon, ideally in time for the next release.Must be staffed and worked on either currently, or very soon, ideally in time for the next release.sig/docsCategorizes an issue or PR as relevant to SIG Docs.Categorizes an issue or PR as relevant to SIG Docs.
Description
Improve the K8s style guide
The style guide needs to specify that K8s docs decline to host specific kinds of content:
- Provider- or project-specific content from projects that are not:
- inside the kubernetes or kubernetes-sigs GitHub organizations
- current CNCF projects
- Identical content hosted in multiple locations ("dual-sourced" content)
For example:
| Allowed | Action | Reason |
|---|---|---|
| ✔️ | Linking to Kubernetes in Docker (KinD) docs from K8s docs | The KinD project resides in github.com/kubernetes-sigs. |
| ❌ | Hosting KinD docs in k/website | Dual-sourced content requires duplicated effort from maintainers and tends to go stale/rotten more quickly. |
| ✔️ | Linking to Prometheus docs from K8s docs | Prometheus is a CNCF project |
| ❌ | Linking to rkt docs from K8s docs | rkt is an (almost) archived CNCF project |
Why does this matter?
It's necessary to clarify which kinds of content we do and don't accept in K8s docs.
/sig docs
/priority important-soon
Which page requires an update?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
priority/important-soonMust be staffed and worked on either currently, or very soon, ideally in time for the next release.Must be staffed and worked on either currently, or very soon, ideally in time for the next release.sig/docsCategorizes an issue or PR as relevant to SIG Docs.Categorizes an issue or PR as relevant to SIG Docs.