文档内容指南

此页面包含 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 控制器 和 日志记录。

文档只能链接到 Kubernetes 项目之外的第三方开源软件 (OSS)，前提是 Kubernetes 的功能需要该软件。

双源内容

Kubernetes 文档尽可能链接到权威来源，而不是托管双源内容。

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

更多信息

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

后续步骤

• 阅读 样式指南。