kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
website/content/en/docs/contribute/style/content-guide.md

78 lines
2.7 KiB
Markdown
Raw Normal View History

Add Content Guide to clarify allowed content (#15892) Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-27 00:56:39 +00:00
---
title: Documentation Content Guide
linktitle: Content guide
add en pages
2020-05-30 19:10:23 +00:00
content_type: concept
Add Content Guide to clarify allowed content (#15892) Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-27 00:56:39 +00:00
weight: 10
---
add en pages
2020-05-30 19:10:23 +00:00
<!-- overview -->
Add Content Guide to clarify allowed content (#15892) Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-27 00:56:39 +00:00
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
This page contains guidelines for Kubernetes documentation.
Fix issue of document link in some documents
2020-07-05 13:42:13 +00:00
If you have questions about what's allowed, join the #sig-docs channel in
[Kubernetes Slack](http://slack.k8s.io/) and ask!
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
Fix issue of document link in some documents
2020-07-05 13:42:13 +00:00
You can register for Kubernetes Slack at http://slack.k8s.io/.
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
For information on creating new content for the Kubernetes
docs, follow the [style guide](/docs/contribute/style/style-guide).
Add Content Guide to clarify allowed content (#15892) Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-27 00:56:39 +00:00
add en pages
2020-05-30 19:10:23 +00:00
<!-- body -->
Add Content Guide to clarify allowed content (#15892) Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-27 00:56:39 +00:00
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
## Overview
Source for the Kubernetes website, including the docs, resides in the
[kubernetes/website](https://github.com/kubernetes/website) repository.
Fix en language misspell (#18201) * fix misspell Signed-off-by: Xiang Dai <764524258@qq.com> * clean white noise Signed-off-by: Xiang Dai <764524258@qq.com>
2019-12-20 14:49:32 +00:00
Located in the `kubernetes/website/content/<language_code>/docs` folder, the
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
majority of Kubernetes documentation is specific to the [Kubernetes
Fix issue of document link in some documents
2020-07-05 13:42:13 +00:00
project](https://github.com/kubernetes/kubernetes).
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
## What's allowed
Clarify permitted content
2020-05-28 21:01:43 +00:00
Kubernetes docs allow content for third-party projects only when:
- Content documents software in the Kubernetes project
- Content documents software that's out of project but necessary for Kubernetes to function
- Content is canonical on kubernetes.io, or links to canonical content elsewhere
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
### Third party content
Clarify permitted content
2020-05-28 21:01:43 +00:00
This change has replaced &emdash; to &mdash; within the text (line 42).
2020-04-02 13:06:06 +00:00
Kubernetes documentation includes applied examples of projects in the Kubernetes project&mdash;projects that live in the [kubernetes](https://github.com/kubernetes) and
Fix issue of document link in some documents
2020-07-05 13:42:13 +00:00
[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizations.
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
Fix issue of document link in some documents
2020-07-05 13:42:13 +00:00
Links to active content in the Kubernetes project are always allowed.
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
Fix issue of document link in some documents
2020-07-05 13:42:13 +00:00
Kubernetes requires some third party content to function. Examples include container runtimes (containerd, CRI-O, Docker),
[networking policy](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) (CNI plugins), [Ingress controllers](/docs/concepts/services-networking/ingress-controllers/), and [logging](/docs/concepts/cluster-administration/logging/).
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
Clarify permitted content
2020-05-28 21:01:43 +00:00
Docs can link to third-party open source software (OSS) outside the Kubernetes project only if it's necessary for Kubernetes to function.
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
### Dual sourced content
Wherever possible, Kubernetes docs link to canonical sources instead of hosting
dual-sourced content.
Dual-sourced content requires double the effort (or more!) to maintain
and grows stale more quickly.
{{< note >}}
Fix issue of document link in some documents
2020-07-05 13:42:13 +00:00
If you're a maintainer for a Kubernetes project and need help hosting your own docs,
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
ask for help in [#sig-docs on Kubernetes Slack](https://kubernetes.slack.com/messages/C1J0BPD2M/).
{{< /note >}}
### More information
Add Content Guide to clarify allowed content (#15892) Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-27 00:56:39 +00:00
Fix en language misspell (#18201) * fix misspell Signed-off-by: Xiang Dai <764524258@qq.com> * clean white noise Signed-off-by: Xiang Dai <764524258@qq.com>
2019-12-20 14:49:32 +00:00
If you have questions about allowed content, join the [Kubernetes Slack](http://slack.k8s.io/) #sig-docs channel and ask!
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
Add Content Guide to clarify allowed content (#15892) Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-27 00:56:39 +00:00
add en pages
2020-05-30 19:10:23 +00:00
## {{% heading "whatsnext" %}}
KEP 1327: Apply feedback for third party and dual sourced content (#19486) * Apply feedback for third party and dual sourced content Add feedback from sftim clarify which slack * Limit third-party content to OSS See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 22:45:25 +00:00
Add Content Guide to clarify allowed content (#15892) Add new section for content guidelines Add table of examples of what is and is not allowed Add examples of links to Linux Academy courses based on discussion during the Aug 20 SIG Docs meeting. Remove example table and reformat based on feedback Move content guide to its own page Update existing pages to mention new Content Guide page Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
2019-08-27 00:56:39 +00:00
* Read the [Style guide](/docs/contribute/style/style-guide).