Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Style Guide Regarding Third-Party Content #15774

Closed
wants to merge 4 commits into from
Closed

Clarify Style Guide Regarding Third-Party Content #15774

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8398508
Merge pull request #1 from kubernetes/master
aimeeu Aug 7, 2019
ff72091
Add section on allowed content
aimeeu Aug 9, 2019
0f170d6
Add section on allowed content
aimeeu Aug 9, 2019
044eed3
Change section heading; add links to CNCF projects
aimeeu Aug 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions content/en/docs/contribute/style/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,26 @@ The English-language documentation uses U.S. English spelling and grammar.

{{< comment >}}[If you're localizing this page, you can omit the point about US English.]{{< /comment >}}

## What Kubernetes documentation does and doesn't contain
aimeeu marked this conversation as resolved.
Show resolved Hide resolved

Kubernetes documentation only hosts content from projects within the
`kubernetes` or `kubernetes-sigs` GitHub organizations or from current CNCF
projects.
aimeeu marked this conversation as resolved.
Show resolved Hide resolved

Kubernetes documentation does not host identical content sourced from
multiple locations ("dual-sourced" content).
aimeeu marked this conversation as resolved.
Show resolved Hide resolved

For example:

| Allowed | Action | Reason |
|:-------:|:------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------|
| Yes | Linking to Kubernetes in Docker (KinD) docs from k8s docs | The KinD project resides in `kubernetes-sigs` GitHub organization. |
| No | Hosting KinD docs in k8s website | Dual-sourced content requires duplicated effort from project maintainers and tends to go stale/rotten more quickly. |
aimeeu marked this conversation as resolved.
Show resolved Hide resolved
| Yes | Linking to Prometheus docs from k8s docs | Prometheus is a CNCF project. |
| No | Linking to rkt docs from k8s docs | rkt is an archived CNCF project and no longer current. |
| No | Hosting a tutorial for a specific product, whether inside or outside the CNCF | Dual-sourced content isn't allowed. |
| No | Linking to an online training course | Kubernetes Docs does not control third-party content.

## Documentation formatting standards

### Use camel case for API objects
Expand Down