文档内容指南

本页面包含 Kubernetes 文档编写指南。

如果您对什么是允许的内容有疑问，请加入 Kubernetes Slack 中的 #sig-docs 频道进行咨询！

您可以前往 https://slack.k8s.io/ 注册加入 Kubernetes Slack。

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

概述

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

大部分 Kubernetes 文档位于 kubernetes/website/content/<语言代码>/docs 文件夹中，专门针对 Kubernetes 项目。

允许的内容

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

• 内容记录的是 Kubernetes 项目中的软件
• 内容记录的是项目之外但对于 Kubernetes 运行所必需的软件
• 内容是 kubernetes.io 上的规范内容，或链接至其他地方的规范内容

第三方内容

Kubernetes 文档包含 Kubernetes 项目中项目的实际应用示例，这些项目位于 kubernetes 和 kubernetes-sigs GitHub 组织下。

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

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

仅当 Kubernetes 运行确实需要时，文档才可以链接到 Kubernetes 项目之外的第三方开源软件 (OSS)。

双源内容

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

维护双源内容需要双倍（甚至更多！）的精力，并且更容易过时。

更多信息

如果您对允许的内容有疑问，请加入 Kubernetes Slack 的 #sig-docs 频道并进行咨询！

接下来

• 请阅读风格指南。