文档内容指南

本页面包含 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 频道并提问！

下一步

• 阅读 样式指南。