10
10
title : 为发行版本撰写功能特性文档
11
11
---
12
12
<!--
13
+ ---
13
14
title: Documenting a feature for a release
14
15
linktitle: Documenting for a release
15
16
content_type: concept
19
20
name: contribute
20
21
weight: 45
21
22
title: Documenting a feature for a release
23
+ ---
22
24
-->
23
25
24
26
<!-- overview -->
@@ -188,16 +190,19 @@ SIG Docs 一起工作,确保这一新功能在发行之前已经为之撰写
188
190
1. Open a pull request against the
189
191
`dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small
190
192
commit that you will amend later.
191
- 2. Use the Prow command `/milestone {{< skew nextMinorVersion >}}` to
193
+ 2. Edit the pull request description to include links to [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes)
194
+ PR(s) and [kubernetes/enhancements](https://github.com/kubernetes/enhancements) issue(s).
195
+ 3. Use the Prow command `/milestone {{< skew nextMinorVersion >}}` to
192
196
assign the PR to the relevant milestone. This alerts the docs person managing
193
197
this release that the feature docs are coming.
194
198
-->
195
199
### 提交占位 PR {#open-a-placeholder-pr}
196
200
197
201
1 . 在 ` kubernetes/website ` 仓库上针对 ` dev-{{< skew nextMinorVersion >}} `
198
202
分支提交一个 PR,其中包含较少的、待以后慢慢补齐的提交内容。
199
- 1 . 使用 Prow 命令 ` /milestone {{< skew nextMinorVersion >}} ` 将 PR
200
- 指派到对应的里程碑。这样做会提醒负责管理对应发行版本的文档团队成员,有
203
+ 1 . 编辑拉取请求描述以包括指向 [ kubernetes/kubernetes] ( https://github.com/kubernetes/kubernetes ) PR和 [ kubernetes/enhancements] ( https://github.com/kubernetes/enhancements ) 问题的链接。
204
+ 1 . 使用 Prow 命令 ` /milestone {{< skew nextMinorVersion >}} `
205
+ 将 PR指派到对应的里程碑。这样做会提醒负责管理对应发行版本的文档团队成员,有
201
206
新的功能特性要合并到将来版本。
202
207
203
208
<!--
@@ -221,7 +226,9 @@ Do your best to describe your feature and how to use it. If you need help
221
226
structuring your documentation, ask in the `#sig-docs` slack channel.
222
227
223
228
When you complete your content, the documentation person assigned to your
224
- feature reviews it. Use their suggestions to get the content to a release
229
+ feature reviews it.
230
+ To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s).
231
+ Use their suggestions to get the content to a release
225
232
ready state.
226
233
227
234
If your feature needs documentation and the first draft content is not
@@ -235,6 +242,7 @@ received, the feature may be removed from the milestone.
235
242
在 ` #sig-docs ` Slack 频道中提问。
236
243
237
244
当你已经完成内容撰写,指派给你的功能特性的文档贡献者会去评阅文档。
245
+ 为了确保技术准确性,内容可能还需要相应SIG的技术审核。
238
246
尽量利用他们所给出的建议,改进文档内容以达到发布就绪状态。
239
247
240
248
如果你的功能特性需要文档,而一直没有关于该特性的文档提交评阅,
@@ -253,7 +261,7 @@ add it to [Alpha/Beta Feature gates](/docs/reference/command-line-tools-referenc
253
261
as part of your pull request. If your feature is moving out of Alpha, make sure to
254
262
remove it from that table.
255
263
-->
256
- ### 所有 PRs 均经过评审且合并就绪
264
+ ### 所有 PR 均经过评审且合并就绪
257
265
258
266
如果你的 PR 在发行截止日期之前尚未合并到 ` dev-{{< skew nextMinorVersion >}} ` 分支,
259
267
请与负责管理该发行版本的文档团队成员一起合作,在截止期限之前将其合并。
@@ -264,4 +272,3 @@ remove it from that table.
264
272
[ Alpha/Beta 特性门控] ( /zh/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features )
265
273
表格中。
266
274
如果你的功能特性不再是 Alpha 阶段,请确保特性门控状态得到更新。
267
-
0 commit comments