文档内容指南
此页面包含 Kubernetes 文档的指南。
如果您对允许的内容有任何疑问,请加入 Kubernetes Slack 中的 #sig-docs 频道并提出问题!
您可以在 https://slack.k8s.io/ 注册 Kubernetes Slack。
有关为 Kubernetes 文档创建新内容的信息,请遵循 风格指南。
概述
Kubernetes 网站(包括文档)的源代码位于 kubernetes/website 存储库中。
位于 kubernetes/website/content/<language_code>/docs
文件夹中,大多数 Kubernetes 文档特定于 Kubernetes 项目。
允许的内容
Kubernetes 文档仅在以下情况下允许第三方项目的内容
- 内容记录 Kubernetes 项目中的软件
- 内容记录项目之外但 Kubernetes 正常运行所必需的软件
- 内容是 kubernetes.io 上的规范内容,或者链接到其他地方的规范内容
第三方内容
Kubernetes 文档包含 Kubernetes 项目中项目的应用示例——这些项目位于 kubernetes 和 kubernetes-sigs GitHub 组织中。
始终允许链接到 Kubernetes 项目中的活动内容。
Kubernetes 需要一些第三方内容才能正常运行。示例包括容器运行时(containerd、CRI-O、Docker)、网络策略(CNI 插件)、Ingress 控制器 和 日志记录。
文档只能链接到 Kubernetes 项目之外的第三方开源软件 (OSS),前提是它对 Kubernetes 的正常运行至关重要。
双源内容
尽可能地,Kubernetes 文档链接到规范来源,而不是托管双源内容。
双源内容需要双倍(或更多!)的维护工作,并且会更快地过时。
注意
如果您是 Kubernetes 项目的维护者,并且需要帮助托管自己的文档,请在 Kubernetes Slack 上的 #sig-docs 中寻求帮助。更多信息
如果您对允许的内容有任何疑问,请加入 Kubernetes Slack #sig-docs 频道并提出问题!
下一步
- 阅读 风格指南。
上次修改时间:2023 年 6 月 1 日下午 9:43 PST:调整 content-organization.md 中的换行符 (1ec7fe8e63)