diff --git a/content/zh-cn/docs/contribute/new-content/new-features.md b/content/zh-cn/docs/contribute/new-content/new-features.md index be8c269fd9..8c57d0f3bf 100644 --- a/content/zh-cn/docs/contribute/new-content/new-features.md +++ b/content/zh-cn/docs/contribute/new-content/new-features.md @@ -43,11 +43,13 @@ SIG Docs 团队会提供文字方面的反馈意见,或者直接编辑文档 本节讨论两个小组在分支方面和发行期间所遵从的流程方面的约定。 + 如果对应的功能特性不需要任何类型的文档变更,请通过在 `#sig-release` Slack 频道声明这一点以确保 sig-release 团队了解。 @@ -259,15 +259,14 @@ content is not received, the feature may be removed from the milestone. If your feature is an Alpha or Beta feature and is behind a feature gate, you need a feature gate file for it inside `content/en/docs/reference/command-line-tools-reference/feature-gates/`. -The name of the file should be the feature gate, converted from `UpperCamelCase` -to `kebab-case`, with `.md` as the suffix. +The name of the file should be the name of the feature gate with `.md` as the suffix. You can look at other files already in the same directory for a hint about what yours should look like. Usually a single paragraph is enough; for longer explanations, add documentation elsewhere and link to that. --> 如果你在处理的特性处于 Alpha 或 Beta 阶段并由某特性门控控制, 你需要在 `content/en/docs/reference/command-line-tools-reference/feature-gates/` 目录中为其创建一个特性门控文件。 -此文件的名称应该是特性门控的名称,此名称的式样从 `UpperCamelCase` 转换为 `kebab-case`,并以 `.md` 作为后缀。 +文件名应为特性门控的名称,并以 `.md` 作为后缀。 你可以参照同一目录中已存在的其他文件,以了解你的文件应该是什么样子的。 通常一段话就够了;若要长篇阐述,请在其他地方添加文档,并为其添加链接。 @@ -300,9 +299,8 @@ stages: ``` 对于全新的特性门控,还需要一个单独的特性门控描述;在 @@ -332,7 +330,8 @@ table. For example: 如果你的特性已经是 GA(正式发布)或已弃用的,请在描述文件的 `stages` 块中包含一个额外的 `stage` 条目。 确保 Alpha 和 Beta 阶段保持不变。这一步将特性门控从 [Alpha/Beta 特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) -表格移到[已毕业或已弃用的特性门控](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)表格。例如: +表格移到[已毕业或已弃用的特性门控](/zh-cn/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)表格。 +例如: