为发行版本撰写功能特性文档

Kubernetes 的每个主要版本发布都会包含一些需要文档说明的新功能。新的发行版本也会对已有功能特性和文档（例如将某功能特性从 Alpha 升级为 Beta）进行更新。

通常，负责某功能特性的 SIG 要为功能特性的文档草拟文档，并针对 kubernetes/website 仓库的合适的开发分支发起拉取请求。 SIG Docs 团队会提供文字方面的反馈意见，或者直接编辑文档草稿。本节讨论两个小组在分支方面和发行期间所遵从的流程方面的约定。

对于文档贡献者

一般而言，文档贡献者不会为某个发行版本从头撰写文档。相反，他们会与开发该功能特性的 SIG 团队一起，对文档草稿进行润色，使之符合发布条件。

在你选定了某个功能特性，为其撰写文档（主笔或辅助），请在 #sig-docs Slack 频道、SIG Docs 的每周例会上，或者在功能特性对应的 PR 上提出咨询。如果继续工作是没有问题的，你可以使用提交到他人的 PR 所述的某个技巧参与 PR 的编辑工作。

了解即将发布的功能特性

要了解即将发布的功能特性，可以参加每周的 SIG Release 例会（参考社区页面，了解即将召开的会议），监视 kubernetes/sig-release 中与发行相关的文档。每个发行版本在 /sig-release/tree/master/releases/ 下都有一个对应的子目录。该子目录包含了发行版本的时间计划、发行公告的草稿以及列举发行团队名单的文档。

发行时间计划文件中包含到所有其他文档、会议、会议记录及发行相关的里程碑的链接。其中也包含关于发行版本的目标列表、时间线，以及当前发行版本中就绪的特殊流程的信息。文档末尾附近定义了若干与该发行版本有关的术语。

此文档也包含到 功能特性跟踪清单 的链接。这一清单是了解哪些功能特性计划进入某发行版本的正式途径。

发行团队文档列举了哪些人扮演着各个发行版本的不同角色。如果不清楚要联系谁来讨论特定的功能特性或者回答你的问题，你可以参加发行团队的会议，提出你的问题，或者联系发行团队的牵头人，这样他们就可以帮你找到正确的联系人。

发行说明草稿是用来发现与特定发行版本相关的功能特性、变更、废弃以及其他信息的好来源。由于在发行周期的后段该文档的内容才会最终定稿，参考其中的信息时请谨慎。

特性跟踪清单

针对给定 Kubernetes 发行版本特性跟踪清单中列举的是计划包含于该版本中的每个功能特性。每一行中都包含特性的名称、特性对应的主要 GitHub Issue，其稳定性级别（ALpha、 Beta 或 Stable）、负责实现该特性的 SIG 和个人、是否该特性需要文档、该特性的发行说明草稿以及该特性是否已经被合并等等。阅读此清单时请注意：

Beta 和 Stable 功能特性通常比 Alpha 特性更为需要文档支持。
如果某功能特性尚未被合并，就很难测试或者为其撰写文档。对于对应的 PR 而言，也很难讲特性是否完全实现。
确定某个功能特性是否需要文档的过程是一个手动的过程。即使某个功能特性没有标记需要文档，你仍可能需要为其提供文档。

针对开发人员或其他 SIG 成员

本节中的信息是针对为发行版本中新功能特性撰写文档的来自其他 Kubernetes SIG 的成员。

如果你是某个 SIG 的成员，负责为 Kubernetes 开发某一项新的功能特性，你需要与 SIG Docs 一起工作，确保这一新功能在发行之前已经为之撰写文档。请参考特性跟踪清单或者 Kubernetes Slack 上的 #sig-release 频道，检查时间安排的细节以及截止日期。

提交占位 PR

在 kubernetes/website 仓库上针对 dev-1.33 分支提交一个draft PR，其中包含较少的、待以后慢慢补齐的提交内容。要创建一个草案（draft）状态的 PR，可以在 Create Pull Request 下拉菜单中选择 Create Draft Pull Request，然后点击 Draft Pull Request。
编辑拉取请求描述以包括指向 kubernetes/kubernetes PR 和 kubernetes/enhancements 问题的链接。
在对应的 kubernetes/enhancements issue 上添加评论，附上新 PR 的链接以便管理此发行版本的人员能够得到通知，了解特性的文档正在被撰写，在新的发行版本中要跟踪其进展。

如果对应的功能特性不需要任何类型的文档变更，请通过在 #sig-release Slack 频道声明这一点以确保 sig-release 团队了解。如果功能特性确实需要文档，而没有对应的 PR 提交，该功能特性可能会被从里程碑中移除。

PR 准备好评阅

时机成熟时，你可以在你的占位 PR 中完成功能特性文档，并将 PR 的状态从草案状态更改为 Ready for Review。要将一个拉取请求标记为已准备好评阅，转到页面的 merge 框，点击 Ready for review。

尽可能为功能特性提供详尽文档以及使用说明。如果你需要文档组织方面的帮助，请在 #sig-docs Slack 频道中提问。

当你已经完成内容撰写，指派给你的功能特性的文档贡献者会去评阅文档。为了确保技术准确性，内容可能还需要相应 SIG 的技术审核。尽量利用他们所给出的建议，改进文档内容以达到发布就绪状态。

如果你的特性需要文档，而你未提交初版文档，那此特性可能会被从里程碑中移除。

特性门控

如果你在处理的特性处于 Alpha 或 Beta 阶段并由某特性门控控制，你需要在 content/en/docs/reference/command-line-tools-reference/feature-gates/ 目录中为其创建一个特性门控文件。此文件的名称应该是特性门控的名称，此名称的式样从 UpperCamelCase 转换为 kebab-case，并以 .md 作为后缀。你可以参照同一目录中已存在的其他文件，以了解你的文件应该是什么样子的。通常一段话就够了；若要长篇阐述，请在其他地方添加文档，并为其添加链接。

此外，为了确保你的特性门控出现在 Alpha/Beta 特性门控表格中，请在 Markdown 描述文件的 Front Matter 中包含以下细节：

stages:
  - stage: <alpha/beta/stable/deprecated>  # 指定特性门控的开发阶段
    defaultValue: <true or false>     # 如果默认启用，则设置为 true，否则为 false
    fromVersion: <Version>            # 特性门控可用的起始版本
    toVersion: <Version>              # （可选）特性门控可用的结束版本

对于全新的特性门控，还需要一个单独的特性门控描述；在 content/en/docs/reference/command-line-tools-reference/feature-gates/ 目录中创建一个新的 Markdown 文件（把其他文件用作模板）。

当你将特性门控从默认禁用更改为默认启用时，你可能还需要更改其他文档（不仅仅是特性门控列表）。参照这样的话术 “exampleSetting 字段是一个 Beta 字段，默认禁用。你可以通过启用 ProcessExampleThings 特性门控来启用此字段。”

如果你的特性已经是 GA（正式发布）或已弃用的，请在描述文件的 stages 块中包含一个额外的 stage 条目。确保 Alpha 和 Beta 阶段保持不变。这一步将特性门控从 Alpha/Beta 特性门控表格移到已毕业或已弃用的特性门控表格。例如：

stages:
  - stage: alpha 
    defaultValue: false
    fromVersion: "1.12"
    toVersion: "1.12"
  - stage: beta 
    defaultValue: true
    fromVersion: "1.13"
    toVersion: "1.18"    
  # 将 'stable' stage 代码块添加到了 stages 下 
  - stage: stable     
    defaultValue: true
    fromVersion: "1.19"
    toVersion: "1.27"

最终，Kubernetes 将完全停止包含此特性门控。为了表示某特性门控已被移除，请在相应描述文件的 Front Matter 中包括 removed: true。此操作将使特性门控及其描述从已毕业或已弃用的特性门控部分移到名为特性门控（已移除）的专用页面。

所有 PR 均经过评审且合并就绪

如果你的 PR 在发行截止日期之前尚未合并到 dev-1.33 分支，请与负责管理该发行版本的文档团队成员一起合作，在截止期限之前将其合并。如果功能特性需要文档，而文档并未就绪，该特性可能会被从里程碑中去除。

最后修改 December 11, 2024 at 10:24 PM PST: Merge pull request #48984 from chanieljdan/update-release-1.30-hugo.toml (6806f17)