文档内容指南

本页包含 Kubernetes 文档的指导方针。

如果对哪些内容是允许的有疑问，请加入 Kubernetes Slack 中的 #sig-docs 频道提问！

你可以在 https://slack.k8s.io/ 注册加入 Kubernetes Slack。

有关如何为 Kubernetes 文档创建新内容的信息，请遵循风格指南。

概述

Kubernetes 网站（包括文档）的源代码位于 kubernetes/website 仓库中。

大多数 Kubernetes 文档都位于 kubernetes/website/content/<language_code>/docs 文件夹中，且专用于 Kubernetes 项目。

允许的内容

Kubernetes 文档仅在以下情况允许包含第三方项目内容：

• 内容记录 Kubernetes 项目中的软件
• 内容记录项目之外但对 Kubernetes 正常运行必不可少的软件
• 内容在 kubernetes.io 上是权威的，或者链接到其他地方的权威内容

第三方内容

Kubernetes 文档包括 Kubernetes 项目中的应用示例——这些项目位于 kubernetes 和 kubernetes-sigs GitHub 组织中。

始终允许链接到 Kubernetes 项目中的活跃内容。

Kubernetes 需要一些第三方内容才能正常运行。例如，容器运行时（containerd、CRI-O、Docker）、网络策略（CNI 插件）、Ingress 控制器和日志。

文档仅在第三方开源软件 (OSS) 对 Kubernetes 正常运行必不可少的情况下，才能链接到该软件。

双源内容

在可能的情况下，Kubernetes 文档链接到权威来源，而不是托管双源内容。

双源内容需要双倍（或更多！）的维护工作，而且更容易过时。

更多信息

如果对允许的内容有疑问，请加入 Kubernetes Slack 的 #sig-docs 频道提问！

下一步

• 阅读风格指南。