@@ -88,7 +88,7 @@ For example, to create a `whatsnext` heading, add the heading shortcode with the
88
88
- seealso
89
89
- options
90
90
91
- 例如,要创建一个 ` whatsnext ` 标题,添加 heading 短代码并指定 "whatsnext" 字符串:
91
+ 例如,要创建一个 ` whatsnext ` 标题,添加 ` heading ` 短代码并指定 "whatsnext" 字符串:
92
92
93
93
``` none
94
94
## {{%/* heading "whatsnext" */%}}
@@ -163,16 +163,16 @@ Concept pages are divided into three sections:
163
163
中的 Deployment 对象,解释其作为应用的角色如何部署、扩缩和更新。
164
164
通常,概念页面不需要包含步骤序列,但包含指向任务或教程的链接。
165
165
166
- 要编写一个新的概念页面,在 ` /content/en/docs/concepts ` 目录下面的子目录中新建
167
- 一个 Markdown 文件。 该文件具有以下特点。
166
+ 要编写一个新的概念页面,在 ` /content/en/docs/concepts ` 目录下面的子目录中新建一个 Markdown 文件。
167
+ 该文件具有以下特点。
168
168
169
169
概念页面分为三个章节:
170
170
171
171
| 页面章节 |
172
172
| --------------------|
173
- | overview (概述) |
174
- | body (主体) |
175
- | whatsnext ( 接下来)|
173
+ | overview(概述) |
174
+ | body(正文) |
175
+ | whatsnext( 接下来)|
176
176
177
177
<!--
178
178
The `overview` and `body` sections appear as comments in the concept page.
@@ -193,13 +193,12 @@ published example of a concept page.
193
193
194
194
在为每个章节撰写内容时,遵从一些规定:
195
195
196
- - 使用二级和三级标题(H2、H3)来组织内容
197
- - 在 ` overview ` 节中,使用一段文字来为主体部分铺陈上下文 ;
196
+ - 使用二级和三级标题(H2、H3)来组织内容;
197
+ - 在 ` overview ` 节中,使用一段文字概括当前主题的上下文 ;
198
198
- 在 ` body ` 节中,详细解释对应概念;
199
- - 对于 ` whatsnext ` 节,提供一个项目符号列表(最多 5 个),帮助读者进一步学习掌握概念
199
+ - 对于 ` whatsnext ` 节,提供一个项目符号列表(最多 5 个),帮助读者进一步学习掌握概念。
200
200
201
- [ 注解] ( /zh-cn/docs/concepts/overview/working-with-objects/annotations/ ) 页面是一个已经
202
- 上线的概念页面的例子。
201
+ [ 注解] ( /zh-cn/docs/concepts/overview/working-with-objects/annotations/ ) 页面是一个已经上线的概念页面的例子。
203
202
204
203
<!--
205
204
### Task
@@ -222,19 +221,18 @@ To write a new task page, create a Markdown file in a subdirectory of the
222
221
### 任务(Task) {#task}
223
222
224
223
任务页面讲解如何完成某项工作,通常包含由为数不多的几个步骤组成的序列。
225
- 任务页面的讲解文字很少,不过通常会包含指向概念主题的链接,以便读者
226
- 能够了解相关的背景和知识。
224
+ 任务页面的讲解文字很少,不过通常会包含指向概念主题的链接,以便读者能够了解相关的背景和知识。
227
225
228
- 编写新的任务页面时,在 ` /content/en/docs/tasks ` 目录下的子目录中创建一个
229
- 新的 Markdown 文件。 该文件特点如下。
226
+ 编写新的任务页面时,在 ` /content/en/docs/tasks ` 目录下的子目录中创建一个新的 Markdown 文件。
227
+ 该文件特点如下。
230
228
231
229
| 页面章节 |
232
230
| ---------------------------|
233
- | overview (概述) |
234
- | prerequisites (准备工作)|
235
- | steps (步骤) |
236
- | discussion (讨论) |
237
- | whatsnext (接下来) |
231
+ | overview(概述) |
232
+ | prerequisites(准备工作)|
233
+ | steps(步骤) |
234
+ | discussion(讨论) |
235
+ | whatsnext(接下来) |
238
236
239
237
<!--
240
238
The `overview`, `steps`, and `discussion` sections appear as comments in the task page.
@@ -261,17 +259,16 @@ An example of a published task topic is [Using an HTTP proxy to access the Kuber
261
259
262
260
在每个小节内撰写内容时注意以下规定:
263
261
264
- - 最低使用二级标题(H2,标题行前带两个 ` # ` 字符)。每个小节都会由模版自动给出标题 。
265
- - 在 ` overview ` 节中,用一个段落为整个任务主体设定语境 ;
262
+ - 最低使用二级标题(H2,标题行前带两个 ` # ` 字符)。每个小节都会由模板自动给出标题 。
263
+ - 在 ` overview ` 节中,用一个段落为整个任务主题设定语境 ;
266
264
- 在 ` prerequisites ` 节中,尽可能使用项目符号列表。
267
265
额外的环境准备条件要加在 ` include ` 短代码之后。
268
266
默认的环境准备条件是拥有一个在运行的 Kubernetes 集群。
269
267
- 在 ` steps ` 节中,使用编号符号列表。
270
268
- 在 ` discussion ` 节中,使用正常文字内容来对 ` steps ` 节中内容展开叙述。
271
- - 在 ` whatsnext ` 节中,使用项目符号列表(不超过 5 项),列举读者可能接下来有兴趣
272
- 阅读的主题。
269
+ - 在 ` whatsnext ` 节中,使用项目符号列表(不超过 5 项),列举读者可能接下来有兴趣阅读的主题。
273
270
274
- 已上线的任务主题示例之一是[ 使用 HTTP 代理来访问 Kubernetes API] ( /zh-cn/docs/tasks/extend-kubernetes/http-proxy-access-api/ ) 。
271
+ 已上线的任务主题示例之一是[ 使用 HTTP 代理访问 Kubernetes API] ( /zh-cn/docs/tasks/extend-kubernetes/http-proxy-access-api/ ) 。
275
272
276
273
<!--
277
274
### Tutorial
@@ -298,21 +295,21 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
298
295
### 教程(Tutorial) {#tutorial}
299
296
300
297
教程页面描述如果完成一个比单一任务规模更大的目标。通常教程页面会有多个小节,
301
- 每个小节由一系列步骤组成。例如,每个教程可能提供对代码示例的讲解,便于用户
302
- 了解 Kubernetes 的某个功能特性。教程可以包含表面层面的概念解释,对于更深层面
303
- 的概念主题应该使用链接 。
298
+ 每个小节由一系列步骤组成。例如,每个教程可能提供对代码示例的讲解,
299
+ 便于用户了解 Kubernetes 的某个功能特性。教程可以包含表面层面的概念解释,
300
+ 对于更深层面的概念主题应该使用链接 。
304
301
305
302
撰写新的教程页面时,在 ` /content/en/docs/tutorials ` 目录下面的子目录中创建新的
306
303
Markdown 文件。该文件有以下特点。
307
304
308
305
| 页面节区 |
309
306
| ---------------------------|
310
- | overview (概述) |
311
- | prerequisites (环境准备)|
312
- | objectives (目标) |
313
- | lessoncontent (教程内容)|
314
- | cleanup (清理工作) |
315
- | whatsnext (接下来) |
307
+ | overview(概述) |
308
+ | prerequisites(环境准备)|
309
+ | objectives(目标) |
310
+ | lessoncontent(教程内容)|
311
+ | cleanup(清理工作) |
312
+ | whatsnext(接下来) |
316
313
317
314
<!--
318
315
The `overview`, `objectives`, and `lessoncontent` sections appear as comments in the tutorial page.
@@ -335,23 +332,22 @@ Within each section, write your content. Use the following guidelines:
335
332
interested in reading next.
336
333
337
334
An example of a published tutorial topic is
338
- [Running a Stateless Application Using a Deployment](/docs/tutorials/stateless -application/run-stateless-application-deployment/).
335
+ [Running a Stateless Application Using a Deployment](/docs/tasks/run -application/run-stateless-application-deployment/).
339
336
-->
340
337
教程页面的 ` overview ` 、` objectives ` 和 ` lessoncontent ` 小节显示为注释形式。
341
338
你可以使用 ` heading ` 短代码根据需要添加 ` prerequisites ` 、` cleanup ` 和
342
339
` whatsnext ` 小节。
343
340
344
341
在每个小节中编写内容时,请注意以下规定:
345
342
346
- - 最低使用二级标题(H2,标题前面有两个 ` # ` 字符)。模版会自动为每个小节设置标题 。
343
+ - 最低使用二级标题(H2,标题前面有两个 ` # ` 字符)。模板会自动为每个小节设置标题 。
347
344
- 在 ` overview ` 节中,用一个段落为整个主题设定语境;
348
345
- 在 ` prerequisites ` 节中,尽可能使用项目符号列表。
349
346
额外的环境准备条件要加在已包含的条件之后。
350
347
- 在 ` objectives ` 节中,使用项目符号列表。
351
348
- 在 ` lessoncontent ` 节中,结合使用编号符号列表和叙述性文字。
352
349
- 在 ` cleanup ` 节中,使用编号符号列表来描述任务结束后清理集群状态所需要的步骤。
353
- - 在 ` whatsnext ` 节中,使用项目符号列表(不超过 5 项),列举读者可能接下来有兴趣
354
- 阅读的主题。
350
+ - 在 ` whatsnext ` 节中,使用项目符号列表(不超过 5 项),列举读者可能接下来有兴趣阅读的主题。
355
351
356
352
已发布的教程主题的一个例子是
357
353
[ 使用 Deployment 运行无状态应用] ( /zh-cn/docs/tasks/run-application/run-stateless-application-deployment/ ) .
@@ -365,7 +361,7 @@ a Kubernetes component tool. Each page generates from scripts using the componen
365
361
A tool reference page has several possible sections:
366
362
367
363
| Page section |
368
- |-------------------------------- |
364
+ |------------------------------|
369
365
| synopsis |
370
366
| options |
371
367
| options from parent commands |
@@ -387,11 +383,11 @@ Examples of published tool reference pages are:
387
383
388
384
| 页面小节 |
389
385
| -----------------|
390
- | synopsis ( 用法)|
386
+ | synopsis( 用法)|
391
387
| options(选项) |
392
- | options from parent commands ( 从父命令集成的选项) |
393
- | examples (示例)|
394
- | seealso (参考)|
388
+ | options from parent commands( 从父命令集成的选项) |
389
+ | examples(示例)|
390
+ | seealso(参考)|
395
391
396
392
已发布的工具参考页面示例包括:
397
393
0 commit comments