Edit This Page

贡献新内容概述

本节包含贡献新内容之前你需要知晓的一些信息。

基本知识

  • 使用 Markdown 来编写 Kubernetes 文档并使用 Hugo 来构建网站
  • 源代码位于 GitHub 仓库中。 你可以在 /content/en/docs/ 目录下找到 Kubernetes 文档。 某些参考文档是使用位于 update-imported-docs/ 目录下的脚本自动生成的。
  • 页面内容类型使用 Hugo 描述文档内容的表现。
  • 除了基本的 Hugo 短代码(shortcodes)外,我们还在文档中使用一些 定制的 Hugo 短代码以控制内容的表现。
  • 文档的源代码有多种语言形式,位于/content/ 目录下。 每种语言都有自己的由两个字母代表的目录,这两个字母是基于 ISO 639-1 标准来确定的。 例如,英语文档源码位于/content/en/docs/ 目录下。
  • 关于在多种语言中为文档做贡献的详细信息,以及如何启动一种新的语言翻译, 可参考本地化文档。

开始之前

签署 CNCF CLA

所有 Kubernetes 贡献者 必须 阅读 贡献者指南签署贡献者授权同意书(Contributor License Agreement,CLA)

来自尚未签署 CLA 的贡献者的 PR 无法通过自动化服务的测试。 你所提供的姓名和邮件地址必须与 git config 中所找到的完全相同, 而且你的 git 用户名和邮件地址必须与用来签署 CNCF CLA 的一致。

选择要使用的分支

在发起拉取请求时,你需要预先知道要基于哪个分支来开展工作。

场景分支
针对当前发行版本的,对现有英文内容的修改或新的英文内容master
针对功能特性变更的内容功能特性所对应的版本所对应的分支,分支名字模式为 dev-release-<version>。例如,如果某功能特性在 v1.18 版本发生变化,则对应的文档变化要添加到 dev-release-1.18 分支。
其他语言的内容(本地化)基于本地化团队的约定。参见本地化分支策略了解更多信息。

如果你仍不能确定要选择哪个分支,请在 #sig-docs Slack 频道上提问。

说明: 如果你已经提交了你的 PR,并且你发现所针对的分支选错了,你(且只能是你)可以重新选择分支。

每个 PR 牵涉的语言

请限制每个 PR 仅涉及一种语言。 如果你需要对多种语言下的同一代码示例进行相同的修改,也请为每种语言发起一个独立的 PR。

为贡献者提供的工具

kubernetes/website 仓库的 文档贡献者工具 目录中包含了一些工具,能够助你的贡献过程更为顺畅。