[zh] Sync /contribute/new-content/new-features.md

This commit is contained in:
Michael 2022-10-05 20:17:27 +08:00
parent 9d625f4583
commit b58e1017ac
1 changed files with 32 additions and 31 deletions

View File

@ -33,8 +33,8 @@ editorial feedback or edits the draft directly. This section covers the branchin
conventions and process used during a release by both groups. conventions and process used during a release by both groups.
--> -->
Kubernetes 的每个主要版本发布都会包含一些需要文档说明的新功能。 Kubernetes 的每个主要版本发布都会包含一些需要文档说明的新功能。
新的发行版本也会对已有功能特性和文档(例如将某功能特性从 alpha 升级为 新的发行版本也会对已有功能特性和文档(例如将某功能特性从 Alpha 升级为
beta进行更新。 Beta进行更新。
通常,负责某功能特性的 SIG 要为功能特性的文档草拟文档,并针对 `kubernetes/website` 通常,负责某功能特性的 SIG 要为功能特性的文档草拟文档,并针对 `kubernetes/website`
仓库的合适的开发分支发起拉取请求。 仓库的合适的开发分支发起拉取请求。
@ -52,19 +52,18 @@ After you've chosen a feature to document or assist, ask about it in the `#sig-d
Slack channel, in a weekly SIG Docs meeting, or directly on the PR filed by the Slack channel, in a weekly SIG Docs meeting, or directly on the PR filed by the
feature SIG. If you're given the go-ahead, you can edit into the PR using one of feature SIG. If you're given the go-ahead, you can edit into the PR using one of
the techniques described in the techniques described in
[Commit into another person's PR](/docs/contribute/review/for-approvers/#commit-into-another-persons-pr). [Commit into another person's PR](/docs/contribute/review/for-approvers/#commit-into-another-person-s-pr).
--> -->
## 对于文档贡献者 ## 对于文档贡献者 {#for-documentation-contributors}
一般而言,文档贡献者不会为某个发行版本从头撰写文档。 一般而言,文档贡献者不会为某个发行版本从头撰写文档。
相反,他们会与开发该功能特性的 SIG 团队一起,对文档草稿进行润色, 相反,他们会与开发该功能特性的 SIG 团队一起,对文档草稿进行润色,
使之符合发布条件。 使之符合发布条件。
在你选定了某个功能特性,为其撰写文档(主笔或辅助),请在 `#sig-docs` Slack 频道、SIG Docs 的每周例会上, 在你选定了某个功能特性,为其撰写文档(主笔或辅助),请在 `#sig-docs` Slack 频道、SIG Docs 的每周例会上,
或者在功能特性对应的 PR 上提出咨询。 或者在功能特性对应的 PR 上提出咨询。如果继续工作是没有问题的,
如果继续工作是没有问题的,你可以使用 你可以使用[提交到他人的 PR](/zh-cn/docs/contribute/review/for-approvers/#commit-into-another-person-s-pr)
[向他人的 PR 中提交](/zh-cn/docs/contribute/review/for-approvers/#commit-into-another-persons-pr) 所述的某个技巧参与 PR 的编辑工作。
中描述的技术之一,参与 PR 的编辑工作。
<!-- <!--
### Find out about upcoming features ### Find out about upcoming features
@ -77,7 +76,7 @@ repository. Each release has a sub-directory in the [/sig-release/tree/master/re
directory. The sub-directory contains a release schedule, a draft of the release directory. The sub-directory contains a release schedule, a draft of the release
notes, and a document listing each person on the release team. notes, and a document listing each person on the release team.
--> -->
### 了解即将发布的功能特性 ### 了解即将发布的功能特性 {#find-out-about-upcoming-features}
要了解即将发布的功能特性,可以参加每周的 SIG Release 例会 要了解即将发布的功能特性,可以参加每周的 SIG Release 例会
(参考[社区](/zh-cn/community/)页面,了解即将召开的会议), (参考[社区](/zh-cn/community/)页面,了解即将召开的会议),
@ -140,8 +139,8 @@ merged. Keep the following in mind:
针对[给定 Kubernetes 发行版本](https://github.com/kubernetes/sig-release/tree/master/releases) 针对[给定 Kubernetes 发行版本](https://github.com/kubernetes/sig-release/tree/master/releases)
特性跟踪清单中列举的是计划包含于该版本中的每个功能特性。 特性跟踪清单中列举的是计划包含于该版本中的每个功能特性。
每一行中都包含特性的名称、特性对应的主要 GitHub Issue其稳定性级别ALpha、 每一行中都包含特性的名称、特性对应的主要 GitHub Issue其稳定性级别ALpha、
Beta 或 Stable、负责实现该特性的 SIG 和个人、是否该特性需要文档、该特性的 Beta 或 Stable、负责实现该特性的 SIG 和个人、是否该特性需要文档、
发行说明草稿以及该特性是否已经被合并等等。阅读此清单时请注意: 该特性的发行说明草稿以及该特性是否已经被合并等等。阅读此清单时请注意:
<!-- <!--
- Beta and Stable features are generally a higher documentation priority than - Beta and Stable features are generally a higher documentation priority than
@ -170,15 +169,14 @@ release. Check the
or check in the `#sig-release` Kubernetes Slack channel to verify scheduling details and or check in the `#sig-release` Kubernetes Slack channel to verify scheduling details and
deadlines. deadlines.
--> -->
## 针对开发人员或其他 SIG 成员 ## 针对开发人员或其他 SIG 成员 {#for-developers-or-other-sig-members}
本节中的信息是针对为发行版本中新功能特性撰写文档的来自其他 Kubernetes SIGs 本节中的信息是针对为发行版本中新功能特性撰写文档的来自其他 Kubernetes SIG 的成员。
的成员。
如果你是某个 SIG 的成员,负责为 Kubernetes 开发某一项新的功能特性,你需要与 如果你是某个 SIG 的成员,负责为 Kubernetes 开发某一项新的功能特性,你需要与
SIG Docs 一起工作,确保这一新功能在发行之前已经为之撰写文档。 SIG Docs 一起工作,确保这一新功能在发行之前已经为之撰写文档。
请参考[特性跟踪清单](https://github.com/kubernetes/sig-release/tree/master/releases) 请参考[特性跟踪清单](https://github.com/kubernetes/sig-release/tree/master/releases)或者
或者 Kubernetes Slack 上的 `#sig-release` 频道,检查时间安排的细节以及截止日期。 Kubernetes Slack 上的 `#sig-release` 频道,检查时间安排的细节以及截止日期。
<!-- <!--
### Open a placeholder PR ### Open a placeholder PR
@ -198,8 +196,8 @@ the feature docs are coming and should be tracked for the release.
1. 在 `kubernetes/website` 仓库上针对 `dev-{{< skew nextMinorVersion >}}` 1. 在 `kubernetes/website` 仓库上针对 `dev-{{< skew nextMinorVersion >}}`
分支提交一个**draft** PR其中包含较少的、待以后慢慢补齐的提交内容。 分支提交一个**draft** PR其中包含较少的、待以后慢慢补齐的提交内容。
要创建一个草案draft状态的 PR可以在 Create Pull Request 下拉菜单中 要创建一个草案draft状态的 PR可以在 Create Pull Request 下拉菜单中选择
选择 **Create Draft Pull Request**,然后点击 **Draft Pull Request** **Create Draft Pull Request**,然后点击 **Draft Pull Request**
1. 编辑拉取请求描述以包括指向 [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) PR 1. 编辑拉取请求描述以包括指向 [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) PR
和 [kubernetes/enhancements](https://github.com/kubernetes/enhancements) 问题的链接。 和 [kubernetes/enhancements](https://github.com/kubernetes/enhancements) 问题的链接。
1. 在对应的 [kubernetes/enhancements](https://github.com/kubernetes/enhancements) 1. 在对应的 [kubernetes/enhancements](https://github.com/kubernetes/enhancements)
@ -225,7 +223,7 @@ When ready, populate your placeholder PR with feature documentation and change
the state of the PR from draft to **ready for review**. To mark a pull request the state of the PR from draft to **ready for review**. To mark a pull request
as ready for review, navigate to the merge box and click **Ready for review**. as ready for review, navigate to the merge box and click **Ready for review**.
Do your best to describe your feature and how to use it. If you need help structuring your documentation, ask in the `#sig-docs` slack channel. Do your best to describe your feature and how to use it. If you need help structuring your documentation, ask in the `#sig-docs` Slack channel.
When you complete your content, the documentation person assigned to your feature reviews it. When you complete your content, the documentation person assigned to your feature reviews it.
To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s). To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s).
@ -233,12 +231,12 @@ Use their suggestions to get the content to a release ready state.
--> -->
### PR 准备好评阅 {#pr-ready-for-review} ### PR 准备好评阅 {#pr-ready-for-review}
时机成熟时,你可以在你的占位 PR 中完成功能特性文档,并将 PR 的状态 时机成熟时,你可以在你的占位 PR 中完成功能特性文档,并将 PR 的状态从草案状态更改为
从草案状态更改为 **Ready for Review**。要将一个拉取请求标记为预备 **Ready for Review**。要将一个拉取请求标记为已准备好评阅,
评阅,转到页面的 merge 框,点击 **Ready for review** 转到页面的 merge 框,点击 **Ready for review**
尽可能为功能特性提供详尽文档以及使用说明。如果你需要文档组织方面的帮助, 尽可能为功能特性提供详尽文档以及使用说明。如果你需要文档组织方面的帮助,
`#sig-docs` Slack 频道中提问。 `#sig-docs` Slack 频道中提问。
当你已经完成内容撰写,指派给你的功能特性的文档贡献者会去评阅文档。 当你已经完成内容撰写,指派给你的功能特性的文档贡献者会去评阅文档。
为了确保技术准确性,内容可能还需要相应 SIG 的技术审核。 为了确保技术准确性,内容可能还需要相应 SIG 的技术审核。
@ -249,17 +247,20 @@ If your feature is an Alpha or Beta feature and is behind a feature gate,
make sure you add it to [Alpha/Beta Feature gates](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) make sure you add it to [Alpha/Beta Feature gates](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)
table as part of your pull request. With new feature gates, a description of table as part of your pull request. With new feature gates, a description of
the feature gate is also required. If your feature is GA'ed or deprecated, the feature gate is also required. If your feature is GA'ed or deprecated,
make sure to move it from that table to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features) make sure to move it from the
[Feature gates for Alpha/Feature](docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
table with Alpha and Beta history intact. table with Alpha and Beta history intact.
--> -->
如果你在处理的功能特性处于 Alpha 或 Beta 阶段并由某特性门控控制, 如果你在处理的功能特性处于 Alpha 或 Beta 阶段并由某特性门控控制,
请确保在你的 PR 中,该特性门控被添加到 请确保在你的 PR 中,该特性门控被添加到
[Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) [Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)表格中。
表格中。对于新的特性门控选项,需要为该特性门控提供一段描述。 对于新的特性门控选项,需要为该特性门控提供一段描述。
如果所处理的功能特性已经进入正式发布GA状态或者被废弃 如果所处理的功能特性已经进入正式发布GA状态或者被废弃
请确保将其从上述表格中迁移到 请确保将其从
[已毕业或废弃的特性](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features) [Alpha 和 Beta 状态的特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)表格迁移到
表格中,并确保迁移后保留其 Alpha、Beta 版本变迁历史。 [已毕业和已废弃的特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
并确保迁移后保留其 Alpha、Beta 版本变迁历史。
<!-- <!--
If your feature needs documentation and the first draft If your feature needs documentation and the first draft