Skip to content

Commit ee9c85d

Browse files
committed
[zh] Sync new-content/new-features.md
1 parent 2f018d4 commit ee9c85d

File tree

1 file changed

+63
-39
lines changed

1 file changed

+63
-39
lines changed

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

Lines changed: 63 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ card:
2424
<!-- overview -->
2525

2626
<!--
27-
Each major Kubernetes release introduces new features that require documentation. New releases also bring updates to existing features and documentation (such as upgrading a feature from alpha to beta).
27+
Each major Kubernetes release introduces new features that require documentation.
28+
New releases also bring updates to existing features and documentation
29+
(such as upgrading a feature from alpha to beta).
2830
2931
Generally, the SIG responsible for a feature submits draft documentation of the
3032
feature as a pull request to the appropriate development branch of the
@@ -33,8 +35,7 @@ editorial feedback or edits the draft directly. This section covers the branchin
3335
conventions and process used during a release by both groups.
3436
-->
3537
Kubernetes 的每个主要版本发布都会包含一些需要文档说明的新功能。
36-
新的发行版本也会对已有功能特性和文档(例如将某功能特性从 Alpha 升级为
37-
Beta)进行更新。
38+
新的发行版本也会更新已有的功能特性和文档(例如将某功能特性从 Alpha 升级为 Beta)。
3839

3940
通常,负责某功能特性的 SIG 要为功能特性的文档草拟文档,并针对 `kubernetes/website`
4041
仓库的合适的开发分支发起拉取请求。
@@ -182,21 +183,21 @@ Kubernetes Slack 上的 `#sig-release` 频道,检查时间安排的细节以
182183
### Open a placeholder PR
183184
184185
1. Open a **draft** pull request against the
185-
`dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small
186-
commit that you will amend later. To create a draft pull request, use the
187-
Create Pull Request drop-down and select **Create Draft Pull Request**,
188-
then click **Draft Pull Request**.
189-
2. Edit the pull request description to include links to [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes)
190-
PR(s) and [kubernetes/enhancements](https://github.com/kubernetes/enhancements) issue(s).
191-
3. Leave a comment on the related [kubernetes/enhancements](https://github.com/kubernetes/enhancements)
192-
issue with a link to the PR to notify the docs person managing this release that
193-
the feature docs are coming and should be tracked for the release.
186+
`dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small
187+
commit that you will amend later. To create a draft pull request, use the
188+
**Create Pull Request** drop-down and select **Create Draft Pull Request**,
189+
then click **Draft Pull Request**.
190+
1. Edit the pull request description to include links to [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes)
191+
PR(s) and [kubernetes/enhancements](https://github.com/kubernetes/enhancements) issue(s).
192+
1. Leave a comment on the related [kubernetes/enhancements](https://github.com/kubernetes/enhancements)
193+
issue with a link to the PR to notify the docs person managing this release that
194+
the feature docs are coming and should be tracked for the release.
194195
-->
195196
### 提交占位 PR {#open-a-placeholder-pr}
196197

197198
1.`kubernetes/website` 仓库上针对 `dev-{{< skew nextMinorVersion >}}`
198199
分支提交一个**draft** PR,其中包含较少的、待以后慢慢补齐的提交内容。
199-
要创建一个草案(draft)状态的 PR,可以在 Create Pull Request 下拉菜单中选择
200+
要创建一个草案(draft)状态的 PR,可以在 **Create Pull Request** 下拉菜单中选择
200201
**Create Draft Pull Request**,然后点击 **Draft Pull Request**
201202
1. 编辑拉取请求描述以包括指向 [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) PR
202203
[kubernetes/enhancements](https://github.com/kubernetes/enhancements) 问题的链接。
@@ -223,7 +224,8 @@ When ready, populate your placeholder PR with feature documentation and change
223224
the state of the PR from draft to **ready for review**. To mark a pull request
224225
as ready for review, navigate to the merge box and click **Ready for review**.
225226
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.
227+
Do your best to describe your feature and how to use it. If you need help
228+
structuring your documentation, ask in the `#sig-docs` Slack channel.
227229
228230
When you complete your content, the documentation person assigned to your feature reviews it.
229231
To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s).
@@ -270,10 +272,11 @@ add documentation elsewhere and link to that.
270272
通常一段话就够了;若要长篇阐述,请在其他地方添加文档,并为其添加链接。
271273

272274
<!--
273-
Also,
274-
to ensure your feature gate appears in the [Alpha/Beta Feature gates](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table, include the following details
275-
in the [front matter](https://gohugo.io/content-management/front-matter/) of your Markdown
276-
description file:
275+
Also, to ensure your feature gate appears in the
276+
[Alpha/Beta Feature gates](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)
277+
table, include the following details in the
278+
[front matter](https://gohugo.io/content-management/front-matter/)
279+
of your Markdown description file:
277280
-->
278281
此外,为了确保你的特性门控出现在
279282
[Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)表格中,
@@ -307,7 +310,7 @@ inside `content/en/docs/reference/command-line-tools-reference/feature-gates/`
307310
目录中创建一个新的 Markdown 文件(把其他文件用作模板)。
308311

309312
<!--
310-
When you change a feature gate to disabled-by-default to enabled-by-default,
313+
When you change a feature gate from disabled-by-default to enabled-by-default,
311314
you may also need to change other documentation (not just the list of
312315
feature gates). Watch out for language such as ”The `exampleSetting` field
313316
is a beta field and disabled by default. You can enable it by enabling the
@@ -318,22 +321,39 @@ is a beta field and disabled by default. You can enable it by enabling the
318321
你可以通过启用 `ProcessExampleThings` 特性门控来启用此字段。”
319322

320323
<!--
321-
If your feature is GA'ed or deprecated,
322-
include an additional `stage` entry within the `stages` block in the description file.
323-
Ensure that the Alpha and Beta stages remain intact.
324-
This step transitions the feature gate from the
325-
[Feature gates for Alpha/Feature](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
326-
to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features) table. For example:
324+
If your feature is GA'ed or deprecated, include an additional `stage` entry within
325+
the `stages` block in the description file.
326+
Ensure that the Alpha and Beta stages remain intact. This step transitions the
327+
feature gate from the
328+
[Feature gates for Alpha/Beta](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
329+
to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)
330+
table. For example:
327331
-->
328332
如果你的特性已经是 GA(正式发布)或已弃用的,请在描述文件的 `stages` 块中包含一个额外的 `stage` 条目。
329333
确保 Alpha 和 Beta 阶段保持不变。这一步将特性门控从
330334
[Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)
331335
表格移到[已毕业或已弃用的特性门控](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)表格。例如:
332336

333337
<!--
334-
# Added 'stable' stage block to existing stages.
338+
{{< highlight yaml "linenos=false,hl_lines=10-17" >}}
339+
stages:
340+
- stage: alpha
341+
defaultValue: false
342+
fromVersion: "1.12"
343+
toVersion: "1.12"
344+
- stage: beta
345+
defaultValue: true
346+
fromVersion: "1.13"
347+
# Added a `toVersion` to the previous stage.
348+
toVersion: "1.18"
349+
# Added 'stable' stage block to existing stages.
350+
- stage: stable
351+
defaultValue: true
352+
fromVersion: "1.19"
353+
toVersion: "1.27"
354+
{{< / highlight >}}
335355
-->
336-
{{< highlight yaml "linenos=false,hl_lines=10-15" >}}
356+
{{< highlight yaml "linenos=false,hl_lines=10-17" >}}
337357
stages:
338358
- stage: alpha
339359
defaultValue: false
@@ -342,33 +362,37 @@ stages:
342362
- stage: beta
343363
defaultValue: true
344364
fromVersion: "1.13"
365+
# 将 `toVersion` 添加到了前一个 stage
345366
toVersion: "1.18"
346367
# 将 'stable' stage 代码块添加到了 stages 下
347-
- stage: stable
368+
- stage: stable
348369
defaultValue: true
349370
fromVersion: "1.19"
350-
toVersion: "1.27"
371+
toVersion: "1.27"
351372
{{< / highlight >}}
352373

353374
<!--
354-
Eventually, Kubernetes will stop including the feature gate at all. To signify the removal of a feature gate,
355-
include `removed: true` in the front matter of the respective description file.
356-
This action triggers the transition of the feature gate
357-
from [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed) section to a dedicated page titled
358-
[Feature Gates (removed)](/docs/reference/command-line-tools-reference/feature-gates-removed/), including its description.
375+
Eventually, Kubernetes will stop including the feature gate at all.
376+
To signify the removal of a feature gate, include `removed: true` in
377+
the front matter of the respective description file.
378+
Making that change means that the feature gate information moves from the
379+
[Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
380+
section to a dedicated page titled
381+
[Feature Gates (removed)](/docs/reference/command-line-tools-reference/feature-gates-removed/),
382+
including its description.
359383
-->
360384
最终,Kubernetes 将完全停止包含此特性门控。为了表示某特性门控已被移除,
361385
请在相应描述文件的 Front Matter 中包括 `removed: true`。
362-
此操作将使特性门控及其描述从[已毕业或已弃用的特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
386+
这种变更意味着特性门控及其描述从[已毕业或已弃用的特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
363387
部分移到名为[特性门控(已移除)](/zh-cn/docs/reference/command-line-tools-reference/feature-gates-removed/)的专用页面。
364388

365389
<!--
366390
### All PRs reviewed and ready to merge
367391

368-
If your PR has not yet been merged into the `dev-{{< skew nextMinorVersion >}}` branch by the release deadline, work with the
369-
docs person managing the release to get it in by the deadline. If your feature needs
370-
documentation and the docs are not ready, the feature may be removed from the
371-
milestone.
392+
If your PR has not yet been merged into the `dev-{{< skew nextMinorVersion >}}`
393+
branch by the release deadline, work with the docs person managing the release
394+
to get it in by the deadline. If your feature needs documentation and the docs
395+
are not ready, the feature may be removed from the milestone.
372396
-->
373397
### 所有 PR 均经过评审且合并就绪 {#all-prs-reviewd-and-ready-to-merge}
374398

0 commit comments

Comments
 (0)