文档内容指南
如果你不清楚哪些事情是可以做的,请加入到 Kubernetes Slack 的 频道提问! 你可以在 注册到 Kubernetes Slack。
关于为 Kubernetes 文档创建新内容的更多信息, 可参考样式指南。
Kubernetes 网站(包括其文档)源代码位于 kubernetes/website 仓库中。
在 目录下, 绝大多数 Kubernetes 文档都是特定于 的。
- 内容所描述的软件在 Kubernetes 项目内
- 内容所描述的软件不在 Kubernetes 项目内,却是让 Kubernetes 正常工作所必需的
Kubernetes 文档包含 Kubernetes 项目下的多个项目的应用示例。 这里的 Kubernetes 项目指的是 Kubernetes 和 GitHub 组织下的那些项目。
链接到 Kubernetes 项目中活跃的内容是一直允许的。
Kubernetes 需要某些第三方内容才能正常工作。例如容器运行时(containerd、CRI-O、Docker)、 联网策略(CNI 插件)、 以及日志等。
只有对应的第三方开源软件(OSS)是运行 Kubernetes 所必需的, 才可以在文档中包含指向这些 Kubernetes 项目之外的软件的链接。
双重来源的内容需要双倍(甚至更多)的投入才能维护,而且通常很快就会变得停滞不前。
说明:
如果你是一个 Kubernetes 项目的维护者,需要帮忙托管你自己的文档, 请在 Kubernetes 的 #sig-docs 频道提出请求。
如果你对允许出现的内容有疑问,请加入到 Kubernetes Slack 的 频道提问!
- 阅读样式指南。