@@ -16,35 +16,39 @@ The Kubernetes documentation follows several types of page content:
16
16
- Tutorial
17
17
- Reference
18
18
19
- Content pages contain HTML headings that create structure on the page.
20
-
21
19
<!-- body -->
22
20
23
21
## Content sections
24
22
25
- Each page content type contains a number of sections.
26
- Most of the main sections are outlined in the page using Markdown comments.
27
- This page structure helps to maintain the different content types.
23
+ Each page content type contains a number of sections declared as
24
+ Markdown comments and HTML headings. HTML section headings render using the
25
+ ` heading ` shortcode. This page structure helps to maintain the different content types.
28
26
29
- For example,
27
+ Examples of Markdown comments defining page content sections:
30
28
31
- ```
29
+ ``` markdown
32
30
<!-- body -->
33
31
```
34
32
35
- ```
33
+ ``` markdown
36
34
<!-- overview -->
37
35
```
38
36
39
- To create localized headings for common headings, use the ` heading ` shortcode
40
- in your content pages. Common localized headings are:
37
+ To create common headings in your content pages, use the ` heading ` shortcode with
38
+ a heading string.
39
+
40
+ Examples of heading strings:
41
41
42
42
- whatsnext
43
43
- prerequisites
44
44
- objectives
45
45
- cleanup
46
+ - synopsis
47
+ - seealso
48
+ - options
46
49
47
- To create a localized ` whatsnext ` heading on a page, you can add to your page:
50
+ To create a ` whatsnext ` heading, add the heading shortcode
51
+ to your page as follows:
48
52
49
53
``` none
50
54
## {{%/* heading "whatsnext" */%}}
@@ -54,29 +58,29 @@ The `whatsnext` heading displays as:
54
58
55
59
## {{% heading "whatsnext" %}}
56
60
57
-
58
- To create a localized ` prerequisites ` heading on a page, you can add to your page:
61
+ You can declare a ` prerequisites ` heading as:
59
62
60
63
``` none
61
64
## {{%/* heading "prerequisites" */%}}
62
65
```
63
66
64
- The `prerequisites heading displays as:
67
+ The ` prerequisites ` heading displays as:
65
68
66
69
## {{% heading "prerequisites" %}}
67
70
71
+ The ` heading ` shortcode takes one string parameter. The string matches the prefix
72
+ of a variable in the ` i18n/<lang>.toml ` files.
68
73
69
- The ` heading ` shortcode takes one parameter.
70
- The string should match the prefix of a variable in the localized file, such ` i18n/en.toml ` :
74
+ ` i18n/en.toml ` :
71
75
72
- ```
76
+ ``` toml
73
77
[whatsnext_heading ]
74
78
other = " What's next"
75
79
```
76
80
77
- Another localized file, such as ` i18n/ko.toml ` :
81
+ ` i18n/ko.toml ` :
78
82
79
- ```
83
+ ``` toml
80
84
[whatsnext_heading ]
81
85
other = " 다음 내용"
82
86
```
@@ -100,16 +104,16 @@ Concept pages are divided into three sections:
100
104
| body |
101
105
| whatsnext |
102
106
103
-
104
107
Fill each section with content. Follow these guidelines:
108
+
105
109
- Organize content with H2 and H3 headings.
106
110
- For ` overview ` , set the topic's context with a single paragraph.
107
111
- For ` body ` , explain the concept.
108
112
- For ` whatsnext ` , provide a bulleted list of topics (5 maximum) to learn more about the concept.
109
113
110
114
[ Annotations] ( /docs/concepts/overview/working-with-objects/annotations/ ) is a published example of a concept page.
111
115
112
- ## Task
116
+ ## Task
113
117
114
118
A task page shows how to do a single thing, typically by giving a short
115
119
sequence of steps. Task pages have minimal explanation, but often provide links
@@ -127,6 +131,7 @@ To write a new task page, create a Markdown file in a subdirectory of the
127
131
| whatsnext |
128
132
129
133
Within each section, write your content. Use the following guidelines:
134
+
130
135
- Use a minimum of H2 headings (with two leading ` # ` characters). The sections
131
136
themselves are titled automatically by the template.
132
137
- For ` overview ` , use a paragraph to set context for the entire topic.
@@ -138,7 +143,7 @@ Within each section, write your content. Use the following guidelines:
138
143
- For ` whatsnext ` , give a bullet list of up to 5 topics the reader might be
139
144
interested in reading next.
140
145
141
- An example of a published task topic is [ Using an HTTP proxy to access the Kubernetes API] ( /docs/tasks/access -kubernetes-api /http-proxy-access-api ) .
146
+ An example of a published task topic is [ Using an HTTP proxy to access the Kubernetes API] ( /docs/tasks/extend -kubernetes/http-proxy-access-api/ ) .
142
147
143
148
## Tutorial
144
149
@@ -162,6 +167,7 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
162
167
| whatsnext |
163
168
164
169
Within each section, write your content. Use the following guidelines:
170
+
165
171
- Use a minimum of H2 headings (with two leading ` # ` characters). The sections
166
172
themselves are titled automatically by the template.
167
173
- For ` overview ` , use a paragraph to set context for the entire topic.
@@ -180,21 +186,21 @@ An example of a published tutorial topic is
180
186
181
187
## Reference
182
188
183
- A component tool reference page shows the ` --help ` output for a Kubernetes component tool.
184
- Each page output depends upon the component tool's source code in ` kubernetes/kubernetes ` .
189
+ A component tool reference page shows the description and flag options output for
190
+ a Kubernetes component tool. Each page output depends upon the component tool's source
191
+ code in ` kubernetes/kubernetes ` .
185
192
186
- Typically a tool reference page has several sections:
193
+ A tool reference page has several possible sections:
187
194
188
195
| Page section |
189
196
| ------------------------------|
190
197
| synopsis |
191
198
| options |
192
199
| options from parent commands |
193
200
| examples |
194
- | body |
195
201
| seealso |
196
202
197
- An example of a published tool reference topic is :
203
+ Examples of published tool reference pages are :
198
204
199
205
- [ kubeadm init] ( /docs/reference/setup-tools/kubeadm/kubeadm-init/ )
200
206
- [ kube-apiserver] ( /docs/reference/command-line-tools-reference/kube-apiserver/ )
0 commit comments