@@ -43,11 +43,13 @@ SIG Docs 团队会提供文字方面的反馈意见,或者直接编辑文档
43
43
本节讨论两个小组在分支方面和发行期间所遵从的流程方面的约定。
44
44
45
45
<!-- body -->
46
+
46
47
<!--
47
48
## For documentation contributors
48
49
49
50
In general, documentation contributors don't write content from scratch for a release.
50
- Instead, they work with the SIG creating a new feature to refine the draft documentation and make it release ready.
51
+ Instead, they work with the SIG creating a new feature to refine the draft documentation
52
+ and make it release ready.
51
53
52
54
After you've chosen a feature to document or assist, ask about it in the `#sig-docs`
53
55
Slack channel, in a weekly SIG Docs meeting, or directly on the PR filed by the
@@ -103,7 +105,7 @@ release.
103
105
其中也包含关于发行版本的目标列表、时间线,以及当前发行版本中就绪的特殊流程的信息。
104
106
文档末尾附近定义了若干与该发行版本有关的术语。
105
107
106
- 此文档也包含到 ** 功能特性跟踪清单** 的链接。
108
+ 此文档也包含到** 功能特性跟踪清单** 的链接。
107
109
这一清单是了解哪些功能特性计划进入某发行版本的正式途径。
108
110
109
111
<!--
@@ -139,7 +141,7 @@ merged. Keep the following in mind:
139
141
140
142
针对[ 给定 Kubernetes 发行版本] ( https://github.com/kubernetes/sig-release/tree/master/releases )
141
143
特性跟踪清单中列举的是计划包含于该版本中的每个功能特性。
142
- 每一行中都包含特性的名称、特性对应的主要 GitHub Issue,其稳定性级别(ALpha 、
144
+ 每一行中都包含特性的名称、特性对应的主要 GitHub Issue,其稳定性级别(Alpha 、
143
145
Beta 或 Stable)、负责实现该特性的 SIG 和个人、是否该特性需要文档、
144
146
该特性的发行说明草稿以及该特性是否已经被合并等等。阅读此清单时请注意:
145
147
@@ -206,11 +208,9 @@ Kubernetes Slack 上的 `#sig-release` 频道,检查时间安排的细节以
206
208
了解特性的文档正在被撰写,在新的发行版本中要跟踪其进展。
207
209
208
210
<!--
209
- If your feature does not need
210
- any documentation changes, make sure the sig-release team knows this, by
211
- mentioning it in the `#sig-release` Slack channel. If the feature does need
212
- documentation but the PR is not created, the feature may be removed from the
213
- milestone.
211
+ If your feature does not need any documentation changes, make sure the sig-release team knows this,
212
+ by mentioning it in the `#sig-release` Slack channel. If the feature does need
213
+ documentation but the PR is not created, the feature may be removed from the milestone.
214
214
-->
215
215
如果对应的功能特性不需要任何类型的文档变更,请通过在 ` #sig-release ` Slack
216
216
频道声明这一点以确保 sig-release 团队了解。
@@ -259,15 +259,14 @@ content is not received, the feature may be removed from the milestone.
259
259
If your feature is an Alpha or Beta feature and is behind a feature gate,
260
260
you need a feature gate file for it inside
261
261
`content/en/docs/reference/command-line-tools-reference/feature-gates/`.
262
- The name of the file should be the feature gate, converted from `UpperCamelCase`
263
- to `kebab-case`, with `.md` as the suffix.
262
+ The name of the file should be the name of the feature gate with `.md` as the suffix.
264
263
You can look at other files already in the same directory for a hint about what yours
265
264
should look like. Usually a single paragraph is enough; for longer explanations,
266
265
add documentation elsewhere and link to that.
267
266
-->
268
267
如果你在处理的特性处于 Alpha 或 Beta 阶段并由某特性门控控制,
269
268
你需要在 ` content/en/docs/reference/command-line-tools-reference/feature-gates/ ` 目录中为其创建一个特性门控文件。
270
- 此文件的名称应该是特性门控的名称,此名称的式样从 ` UpperCamelCase ` 转换为 ` kebab-case ` ,并以 ` .md ` 作为后缀。
269
+ 文件名应为特性门控的名称 ,并以 ` .md ` 作为后缀。
271
270
你可以参照同一目录中已存在的其他文件,以了解你的文件应该是什么样子的。
272
271
通常一段话就够了;若要长篇阐述,请在其他地方添加文档,并为其添加链接。
273
272
@@ -300,9 +299,8 @@ stages:
300
299
` ` `
301
300
302
301
<!--
303
- With net new feature gates, a separate
304
- description of the feature gate is also required; create a new Markdown file
305
- inside ` content/en/docs/reference/command-line-tools-reference/feature-gates/`
302
+ With net new feature gates, a separate description of the feature gate is also required;
303
+ create a new Markdown file inside ` content/en/docs/reference/command-line-tools-reference/feature-gates/`
306
304
(use other files as a template).
307
305
-->
308
306
对于全新的特性门控,还需要一个单独的特性门控描述;在
@@ -332,7 +330,8 @@ table. For example:
332
330
如果你的特性已经是 GA(正式发布)或已弃用的,请在描述文件的 `stages` 块中包含一个额外的 `stage` 条目。
333
331
确保 Alpha 和 Beta 阶段保持不变。这一步将特性门控从
334
332
[Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)
335
- 表格移到[已毕业或已弃用的特性门控](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)表格。例如:
333
+ 表格移到[已毕业或已弃用的特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)表格。
334
+ 例如:
336
335
337
336
<!--
338
337
{{< highlight yaml "linenos=false,hl_lines=10-17" >}}
0 commit comments