文档内容指南

此页面包含 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 Slack #sig-docs 频道并提问！

接下来

• 阅读 风格指南。