为 Kubernetes 文档做贡献

Kubernetes v1.16 版本的文档已不再维护。您现在看到的版本来自于一份静态的快照。如需查阅最新文档,请点击 最新版本。

Edit This Page

文档内容指南

本页包含将内容添加到 Kubernetes 文档的准则。 如果您对允许的内容有疑问,请加入Kubernetes Slack #sig-docs 频道并询问! 用你最好的判断力,随时在 pull request 中对这个文档提交修改。

更多为 Kubernetes 文档创建新内容的信息,请按照样式指南中的说明进行操作。

贡献内容

Kubernetes 文档包含kubernetes/website 资源存储库的内容。 位于 kubernetes/website/content/<language_code>/docs 文件夹中,Kubernetes 文档的主要内容都特定于Kubernetes 项目。 如果这些项目没有自己的文档,Kubernetes 文档中也可能包含 kuberneteskubernetes-sigs 在 GitHub 组织中的项目。 链接到激活的 kubernetes,Kubernetes 文档中的 kubernetes-sigs 和 (CNCF云原生计算基金会 ) 项目始终是被允许的,但是不允许链接到特定供应商的产品。 检查 CNCF 项目列表(已毕业/正在孵化沙盒已存档) ,如果您不确定项目 CNCF 的状态。

双重来源的内容

Kubernetes 文档不包含来自多个网站的重复内容(双重来源 内容)。 双重来源的内容需要重复项目维护者的努力,而且往往会更快过时。 在添加内容之前,请先问自己一下: - 内容是有关激活的 CNCF 项目或 kubernetes 或 kubernetes-sigs GitHub 组织中的项目的内容? - 如果是,则: - 项目是否有自己的文档? - 如果是,请从 Kubernetes 文档链接到该项目的文档 - 如果没有,将内容添加到项目的存储库中,然后从 Kubernetes 文档链接到该存储库 - 如果否,则: - 停止! - 禁止添加有关厂商自定义产品的内容 - 不允许链接到厂商自定义的文档和网站

什么是允许和不允许的

在某些情况下,Kubernetes 文档包含非 Kubernetes 项目的内容。 以下是非 Kubernetes 项目内容的一般类别以及允许和禁止的准则: 1. 在 Kubernetes 的设置或操作过程中涉及非 Kubernetes 项目的教学内容 - 允许: - 引用或链接到有关 CNCF 项目或 kubernetes 或 kubernetes-sigs GitHub 组织中的项目的现有文档 - 示例:用于在学习环境中安装 Kubernetes ,包括成功安装和配置 minikube 并链接到相关 minikube 文档这个先决条件。
- 为没有自己的教学内容的 kubernetes 或 kubernetes-sigs 项目添加内容 - 示例:包括 kubadm 安装和故障排除说明 - 不允许: - 添加在其他存储库中的文档重复的内容 - 例子: - 包括 minikube 安装和配置说明; minikube 有它自己的文件 提供了这些说明 - 包括有关在各种操作系统上安装 Docker, CRI-O, 容器化和其他容器运行时的说明 - 包括有关使用各种项目在生产环境中安装 Kubernetes 的说明: - Kubernetes 钢筋集成引导程序(KRIB)是厂商自定义类型的项目,其内容属于厂商的文档 - Kubernetes 操作 (kops) 在其 GitHub 存储库中具有安装说明和教程 - Kubespray 有自己的文档 - 添加一个教程来说明如何使用厂商自定义产品来执行任务,或不是 CNCF 项目或 kubernetes 或 kubnetes-sigs GitHub 组织中的项目的开源项目来执行任务 - 添加了有关如何使用 CNCF 项目或 kubernetes 或kubnetes-sigs GitHub 组织中的项目的教程,如果该项目具有自己的文档 <!– 1. Detailed technical content about how to use a non-Kubernetes project or how that project is designed

Adding this type of content to the Kubernetes documentation is not allowed. 

–> 1. 有关如何使用非 Kubernetes 项目或如何设计该项目的详细技术内容

不允许将这种类型的内容添加到 Kubernetes 文档中。
  1. 描述非 Kubernetes 项目的内容
    • 允许:
      • 添加有关 CNCF 项目或 kubernetes 或 kubernetes-sigs GitHub 组织中的项目的简短介绍性段落;段落可能包含项目链接
    • 不允许:
      • 添加描述厂商自定义产品的内容
      • 添加内容描述开源项目,该项目不是 CNCF 项目,也不是 kubernetes 或 kubnetes-sigs GitHub 组织中的项目
      • 添加从其他项目中的文档重复的内容,不考虑源存储库
  2. Content that simply links to information about a non-Kubernetes project
    • Allowed:
      • Linking to projects in the kubernetes and kubernetes-sigs GitHub organizations
        • Example: linking to Kubernetes in Docker (KinD) documentation, which resides in the kubernetes-sigs GitHub organization
      • Linking to active CNCF projects
        • Example: linking to the Prometheus documentation; Prometheus is an active CNCF project
    • Not Allowed:
      • Linking to vendor-specific products
      • Linking to archived CNCF projects
      • Linking to inactive projects in the kubernetes and kubernetes-sigs GitHub organizations
      • Linking to open source projects that are not CNCF projects or do not reside in the kubernetes or kubernetes-sigs GitHub organizations –>
  3. 仅链接到有关非 Kubernetes 项目的信息的内容
    • 允许:
      • 链接到 kubernetes 和 kubernetes-sigs GitHub 组织中的项目
        • 示例:链接到 Docker (KinD) 中的 Kubernetes文档,该文件位于 kubernetes-sigs GitHub 组织中
      • 链接到有效的 CNCF 项目
        • 示例:链接到 Prometheus 文档; Prometheus 是一个被激活的 CNCF 项目
    • 不允许:
      • 链接到厂商自定义产品
      • 链接到已归档的 CNCF 项目
      • 链接到 kubernetes 和 kubernetes-sigs GitHub 组织中的非活动项目
      • 链接到不是 CNCF 项目或不在 kubernetes 或 kubernetes-sigs GitHub 组织中的开源项目 <!–
  4. Content about training courses
    • Allowed:
    • Not Allowed:
      • Linking to online training outside of the CNCF, the Linux Foundation, or the Linux Academy; the Kubernetes documentation does not link to third-party content
        • Example: linking to Kubernetes tutorials or courses on Medium, KodeKloud, Udacity, Coursera, learnk8s, and similar websites
      • Linking to vendor-specific tutorials regardless of the training provider
  5. 有关培训课程的内容
    • 允许:
    • 不允许:
      • 链接到 CNCF,Linux 基金会或 Linux 学院之外的在线培训;Kubernetes 文档未链接到第三方内容
        • 示例:链接到 Medium,KodeKloud,Udacity,Coursera,learnk8s 和类似网站上的 Kubernetes 教程或课程
      • 链接到特定于厂商自定义的教程,与培训提供者无关

如果您对允许的内容有疑问,加入Kubernetes Slack #sig-docs 频道并询问!

接下来

反馈