Skip to content

Commit 269d4f0

Browse files
authored
Merge pull request #37162 from windsonsea/newfea
[zh] Sync /contribute/new-content/new-features.md
2 parents 7749023 + b58e101 commit 269d4f0

File tree

1 file changed

+32
-31
lines changed

1 file changed

+32
-31
lines changed

content/zh-cn/docs/contribute/new-content/new-features.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ editorial feedback or edits the draft directly. This section covers the branchin
3333
conventions and process used during a release by both groups.
3434
-->
3535
Kubernetes 的每个主要版本发布都会包含一些需要文档说明的新功能。
36-
新的发行版本也会对已有功能特性和文档(例如将某功能特性从 alpha 升级为
37-
beta)进行更新。
36+
新的发行版本也会对已有功能特性和文档(例如将某功能特性从 Alpha 升级为
37+
Beta)进行更新。
3838

3939
通常,负责某功能特性的 SIG 要为功能特性的文档草拟文档,并针对 `kubernetes/website`
4040
仓库的合适的开发分支发起拉取请求。
@@ -52,19 +52,18 @@ After you've chosen a feature to document or assist, ask about it in the `#sig-d
5252
Slack channel, in a weekly SIG Docs meeting, or directly on the PR filed by the
5353
feature SIG. If you're given the go-ahead, you can edit into the PR using one of
5454
the techniques described in
55-
[Commit into another person's PR](/docs/contribute/review/for-approvers/#commit-into-another-persons-pr).
55+
[Commit into another person's PR](/docs/contribute/review/for-approvers/#commit-into-another-person-s-pr).
5656
-->
57-
## 对于文档贡献者
57+
## 对于文档贡献者 {#for-documentation-contributors}
5858

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

6363
在你选定了某个功能特性,为其撰写文档(主笔或辅助),请在 `#sig-docs` Slack 频道、SIG Docs 的每周例会上,
64-
或者在功能特性对应的 PR 上提出咨询。
65-
如果继续工作是没有问题的,你可以使用
66-
[向他人的 PR 中提交](/zh-cn/docs/contribute/review/for-approvers/#commit-into-another-persons-pr)
67-
中描述的技术之一,参与 PR 的编辑工作。
64+
或者在功能特性对应的 PR 上提出咨询。如果继续工作是没有问题的,
65+
你可以使用[提交到他人的 PR](/zh-cn/docs/contribute/review/for-approvers/#commit-into-another-person-s-pr)
66+
所述的某个技巧参与 PR 的编辑工作。
6867

6968
<!--
7069
### Find out about upcoming features
@@ -77,7 +76,7 @@ repository. Each release has a sub-directory in the [/sig-release/tree/master/re
7776
directory. The sub-directory contains a release schedule, a draft of the release
7877
notes, and a document listing each person on the release team.
7978
-->
80-
### 了解即将发布的功能特性
79+
### 了解即将发布的功能特性 {#find-out-about-upcoming-features}
8180

8281
要了解即将发布的功能特性,可以参加每周的 SIG Release 例会
8382
(参考[社区](/zh-cn/community/)页面,了解即将召开的会议),
@@ -140,8 +139,8 @@ merged. Keep the following in mind:
140139
针对[给定 Kubernetes 发行版本](https://github.com/kubernetes/sig-release/tree/master/releases)
141140
特性跟踪清单中列举的是计划包含于该版本中的每个功能特性。
142141
每一行中都包含特性的名称、特性对应的主要 GitHub Issue,其稳定性级别(ALpha、
143-
Beta 或 Stable)、负责实现该特性的 SIG 和个人、是否该特性需要文档、该特性的
144-
发行说明草稿以及该特性是否已经被合并等等。阅读此清单时请注意:
142+
Beta 或 Stable)、负责实现该特性的 SIG 和个人、是否该特性需要文档、
143+
该特性的发行说明草稿以及该特性是否已经被合并等等。阅读此清单时请注意:
145144

146145
<!--
147146
- Beta and Stable features are generally a higher documentation priority than
@@ -170,15 +169,14 @@ release. Check the
170169
or check in the `#sig-release` Kubernetes Slack channel to verify scheduling details and
171170
deadlines.
172171
-->
173-
## 针对开发人员或其他 SIG 成员
172+
## 针对开发人员或其他 SIG 成员 {#for-developers-or-other-sig-members}
174173

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

178176
如果你是某个 SIG 的成员,负责为 Kubernetes 开发某一项新的功能特性,你需要与
179177
SIG Docs 一起工作,确保这一新功能在发行之前已经为之撰写文档。
180-
请参考[特性跟踪清单](https://github.com/kubernetes/sig-release/tree/master/releases)
181-
或者 Kubernetes Slack 上的 `#sig-release` 频道,检查时间安排的细节以及截止日期。
178+
请参考[特性跟踪清单](https://github.com/kubernetes/sig-release/tree/master/releases)或者
179+
Kubernetes Slack 上的 `#sig-release` 频道,检查时间安排的细节以及截止日期。
182180

183181
<!--
184182
### Open a placeholder PR
@@ -198,8 +196,8 @@ the feature docs are coming and should be tracked for the release.
198196

199197
1.`kubernetes/website` 仓库上针对 `dev-{{< skew nextMinorVersion >}}`
200198
分支提交一个**draft** PR,其中包含较少的、待以后慢慢补齐的提交内容。
201-
要创建一个草案(draft)状态的 PR,可以在 Create Pull Request 下拉菜单中
202-
选择 **Create Draft Pull Request**,然后点击 **Draft Pull Request**
199+
要创建一个草案(draft)状态的 PR,可以在 Create Pull Request 下拉菜单中选择
200+
**Create Draft Pull Request**,然后点击 **Draft Pull Request**
203201
1. 编辑拉取请求描述以包括指向 [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) PR
204202
[kubernetes/enhancements](https://github.com/kubernetes/enhancements) 问题的链接。
205203
1. 在对应的 [kubernetes/enhancements](https://github.com/kubernetes/enhancements)
@@ -225,20 +223,20 @@ When ready, populate your placeholder PR with feature documentation and change
225223
the state of the PR from draft to **ready for review**. To mark a pull request
226224
as ready for review, navigate to the merge box and click **Ready for review**.
227225
228-
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.
226+
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.
229227
230228
When you complete your content, the documentation person assigned to your feature reviews it.
231229
To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s).
232230
Use their suggestions to get the content to a release ready state.
233231
-->
234232
### PR 准备好评阅 {#pr-ready-for-review}
235233

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

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

243241
当你已经完成内容撰写,指派给你的功能特性的文档贡献者会去评阅文档。
244242
为了确保技术准确性,内容可能还需要相应 SIG 的技术审核。
@@ -249,17 +247,20 @@ If your feature is an Alpha or Beta feature and is behind a feature gate,
249247
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)
250248
table as part of your pull request. With new feature gates, a description of
251249
the feature gate is also required. If your feature is GA'ed or deprecated,
252-
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)
250+
make sure to move it from the
251+
[Feature gates for Alpha/Feature](docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
252+
to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
253253
table with Alpha and Beta history intact.
254254
-->
255255
如果你在处理的功能特性处于 Alpha 或 Beta 阶段并由某特性门控控制,
256-
请确保在你的 PR 中,该特性门控被添加到
257-
[Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)
258-
表格中。对于新的特性门控选项,需要为该特性门控提供一段描述。
256+
请确保在你的 PR 中,该特性门控被添加到
257+
[Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)表格中。
258+
对于新的特性门控选项,需要为该特性门控提供一段描述。
259259
如果所处理的功能特性已经进入正式发布(GA)状态或者被废弃,
260-
请确保将其从上述表格中迁移到
261-
[已毕业或废弃的特性](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)
262-
表格中,并确保迁移后保留其 Alpha、Beta 版本变迁历史。
260+
请确保将其从
261+
[Alpha 和 Beta 状态的特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)表格迁移到
262+
[已毕业和已废弃的特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
263+
并确保迁移后保留其 Alpha、Beta 版本变迁历史。
263264

264265
<!--
265266
If your feature needs documentation and the first draft

0 commit comments

Comments
 (0)