2
2
title : 贡献新内容
3
3
content_type : 概念
4
4
main_menu : true
5
- weight : 20
5
+ weight : 25
6
+ simple_list : true # 针对 whatsnext 一节
6
7
---
7
8
<!--
8
9
title: Contributing new content
9
10
content_type: concept
10
11
main_menu: true
11
- weight: 20
12
+ weight: 25
13
+ simple_list: true # for whatsnext section
12
14
-->
13
15
14
16
<!-- overview -->
15
17
16
18
<!--
17
19
This section contains information you should know before contributing new
18
- content.
19
- -->
20
+ content.
20
21
22
+ There are also dedicated pages about submitting [case studies](/docs/contribute/new-content/case-studies)
23
+ and [blog articles](/docs/contribute/blog/).
24
+ -->
21
25
本节包含你在贡献新内容之前需要知晓的信息。
22
26
27
+ 另请参阅如何提交[ 案例分析] ( /zh-cn/docs/contribute/new-content/case-studies ) 和[ 博客文章] ( /zh-cn/docs/contribute/blog/ ) 的专门页面。
28
+
29
+ <!-- body -->
30
+
31
+ <!--
32
+ ## New content task flow
33
+ -->
34
+ ## 新内容的任务流程 {#new-content-task-flow}
35
+
23
36
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
24
37
<!-- You can also cut/paste the mermaid code into the live editor at https://mermaid-js.github.io/mermaid-live-editor to play around with it -->
25
38
@@ -58,8 +71,7 @@ class first,second white
58
71
The figure above depicts the information you should know
59
72
prior to submitting new content. The information details follow.
60
73
-->
61
-
62
- *** 插图 - 贡献新内容准备工作***
74
+ ** 插图 - 贡献新内容准备工作**
63
75
64
76
上图描述了你在提交新内容之前需要知晓的信息。
65
77
详细信息见下文。
@@ -77,9 +89,8 @@ prior to submitting new content. The information details follow.
77
89
the `update-imported-docs/` directory.
78
90
- [Page content types](/docs/contribute/style/page-content-types/) describe the
79
91
presentation of documentation content in Hugo.
80
- -->
81
-
82
- ## 基本知识
92
+ -->
93
+ ## 基本知识 {#contributing-basics}
83
94
84
95
- 使用 Markdown 编写 Kubernetes 文档并使用 [ Hugo] ( https://gohugo.io/ ) 构建网站。
85
96
- Kubernetes 文档使用 [ CommonMark] ( https://commonmark.org/ ) 作为 Markdown 的风格。
@@ -101,7 +112,6 @@ prior to submitting new content. The information details follow.
101
112
or starting a new translation,
102
113
see [localization](/docs/contribute/localization).
103
114
-->
104
-
105
115
- 你可以使用 [ Docsy 短代码] ( https://www.docsy.dev/docs/adding-content/shortcodes/ )
106
116
或[ 定制的 Hugo 短代码] ( /zh-cn/docs/contribute/style/hugo-shortcodes/ ) 贡献 Kubernetes 文档。
107
117
- 除了标准的 Hugo 短代码外,
@@ -115,26 +125,28 @@ prior to submitting new content. The information details follow.
115
125
116
126
<!--
117
127
## Before you begin {#before-you-begin}
128
+
118
129
### Sign the CNCF CLA {#sign-the-cla}
130
+
119
131
All Kubernetes contributors **must** read
120
132
the [Contributor guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md)
121
133
and [sign the Contributor License Agreement (CLA)](https://github.com/kubernetes/community/blob/master/CLA.md).
134
+
122
135
Pull requests from contributors who haven't signed the CLA fail the automated
123
136
tests. The name and email you provide must match those found in
124
137
your `git config`, and your git name and email must match those used for the
125
138
CNCF CLA.
126
139
-->
140
+ ## 开始之前 {#before-you-begin}
127
141
128
- ## 开始之前 {#before-you-begin}
129
-
130
- ### 签署 CNCF CLA {#sign-the-cla}
142
+ ### 签署 CNCF CLA {#sign-the-cla}
131
143
132
144
所有 Kubernetes 贡献者** 必须** 阅读[ 贡献者指南] ( https://github.com/kubernetes/community/blob/master/contributors/guide/README.md )
133
145
并[ 签署贡献者授权同意书 (Contributor License Agreement, CLA)] ( https://github.com/kubernetes/community/blob/master/CLA.md ) 。
134
146
135
147
若贡献者尚未签署 CLA,其发起的 PR 将无法通过自动化测试。
136
148
你所提供的姓名和邮件地址必须与 ` git config ` 中配置的完全相同,
137
- 而且你的 git 用户名和邮件地址必须与用来签署 CNCF CLA 的信息一致。
149
+ 而且你的 Git 用户名和邮件地址必须与用来签署 CNCF CLA 的信息一致。
138
150
139
151
<!--
140
152
### Choose which Git branch to use
@@ -150,26 +162,23 @@ Content in other languages (localizations) | Use the localization's convention.
150
162
151
163
If you're still not sure which branch to choose, ask in `#sig-docs` on Slack.
152
164
-->
153
-
154
- ### 选择要使用的 Git 分支
165
+ ### 选择要使用的 Git 分支 {#choose-which-git-branch-to-use}
155
166
156
167
在发起 PR 时,你需要预先知道基于哪个分支来开展工作。
157
168
158
169
场景 | 分支
159
170
:---------|:------------
160
171
针对当前发行版本的,对现有英文内容的修改或新的英文内容 | ` main `
161
- 针对功能特性变更的内容 | 分支对应于功能特性变更的主要和次要版本,分支名称采用 ` dev-<version> ` 的模式。例如,如果某功能特性在 ` v{{< skew nextMinorVersion >}} ` 版本发生变化,则对应的文档变化要添加到 ` dev-{{< skew nextMinorVersion >}} ` 分支。
162
- 其他语言的内容(本地化) | 基于本地化团队的约定。参见[ 本地化分支策略] ( /zh-cn/docs/contribute/localization/#branch-strategy ) 了解更多信息。
172
+ 针对功能特性变更的内容 | 分支对应于功能特性变更的主要和次要版本,分支名称采用 ` dev-<version> ` 的模式。例如,如果某功能特性在 ` v{{< skew nextMinorVersion >}} ` 版本发生变化,则对应的文档变化要添加到 ` dev-{{< skew nextMinorVersion >}} ` 分支。
173
+ 其他语言的内容(本地化) | 基于本地化团队的约定。参见[ 本地化分支策略] ( /zh-cn/docs/contribute/localization/#branch-strategy ) 了解更多信息。
163
174
164
175
如果你仍不能确定要选择哪个分支,请在 Slack 的 ` #sig-docs ` 频道上提出问题。
165
176
177
+ {{< note >}}
166
178
<!--
167
- {{< note >}} If you already submitted your pull request and you know that the
168
- base branch was wrong, you (and only you, the submitter) can change it. {{<
169
- /note >}}
179
+ If you already submitted your pull request and you know that the
180
+ base branch was wrong, you (and only you, the submitter) can change it.
170
181
-->
171
-
172
- {{< note >}}
173
182
如果你已经提交了 PR,并且发现所针对的分支选错了,你(且只有作为提交人的你)可以更改分支。
174
183
{{< /note >}}
175
184
@@ -180,8 +189,7 @@ Limit pull requests to one language per PR. If you need to make an identical
180
189
change to the same code sample in multiple languages, open a separate PR for
181
190
each language.
182
191
-->
183
-
184
- ### 每个 PR 牵涉的语言
192
+ ### 每个 PR 牵涉的语言 {#languages-per-pr}
185
193
186
194
请确保每个 PR 仅涉及一种语言。
187
195
如果你需要对多种语言下的同一代码示例进行相同的修改,也请为每种语言发起一个独立的 PR。
@@ -193,8 +201,7 @@ The [doc contributors tools](https://github.com/kubernetes/website/tree/main/con
193
201
directory in the `kubernetes/website` repository contains tools to help your
194
202
contribution journey go more smoothly.
195
203
-->
196
-
197
- ## 为贡献者提供的工具
204
+ ## 为贡献者提供的工具 {#tools-for-contributors}
198
205
199
206
` kubernetes/website ` 仓库的[ 文档贡献者工具] ( https://github.com/kubernetes/website/tree/main/content/zh-cn/docs/doc-contributor-tools ) 目录中包含了一些工具,
200
207
有助于使你的贡献过程更为顺畅。
0 commit comments