Skip to content

Commit 0bf1b10

Browse files
committed
fix link, edit content
1 parent b328c19 commit 0bf1b10

File tree

1 file changed

+33
-27
lines changed

1 file changed

+33
-27
lines changed

content/en/docs/contribute/style/page-content-types.md

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,39 @@ The Kubernetes documentation follows several types of page content:
1616
- Tutorial
1717
- Reference
1818

19-
Content pages contain HTML headings that create structure on the page.
20-
2119
<!-- body -->
2220

2321
## Content sections
2422

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.
2826

29-
For example,
27+
Examples of Markdown comments defining page content sections:
3028

31-
```
29+
```markdown
3230
<!-- body -->
3331
```
3432

35-
```
33+
```markdown
3634
<!-- overview -->
3735
```
3836

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:
4141

4242
- whatsnext
4343
- prerequisites
4444
- objectives
4545
- cleanup
46+
- synopsis
47+
- seealso
48+
- options
4649

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:
4852

4953
```none
5054
## {{%/* heading "whatsnext" */%}}
@@ -54,29 +58,29 @@ The `whatsnext` heading displays as:
5458

5559
## {{% heading "whatsnext" %}}
5660

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:
5962

6063
```none
6164
## {{%/* heading "prerequisites" */%}}
6265
```
6366

64-
The `prerequisites heading displays as:
67+
The `prerequisites` heading displays as:
6568

6669
## {{% heading "prerequisites" %}}
6770

71+
The `heading` shortcode takes one string parameter. The string matches the prefix
72+
of a variable in the `i18n/<lang>.toml` files.
6873

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`:
7175

72-
```
76+
```toml
7377
[whatsnext_heading]
7478
other = "What's next"
7579
```
7680

77-
Another localized file, such as `i18n/ko.toml`:
81+
`i18n/ko.toml`:
7882

79-
```
83+
```toml
8084
[whatsnext_heading]
8185
other = "다음 내용"
8286
```
@@ -100,16 +104,16 @@ Concept pages are divided into three sections:
100104
| body |
101105
| whatsnext |
102106

103-
104107
Fill each section with content. Follow these guidelines:
108+
105109
- Organize content with H2 and H3 headings.
106110
- For `overview`, set the topic's context with a single paragraph.
107111
- For `body`, explain the concept.
108112
- For `whatsnext`, provide a bulleted list of topics (5 maximum) to learn more about the concept.
109113

110114
[Annotations](/docs/concepts/overview/working-with-objects/annotations/) is a published example of a concept page.
111115

112-
## Task
116+
## Task
113117

114118
A task page shows how to do a single thing, typically by giving a short
115119
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
127131
| whatsnext |
128132

129133
Within each section, write your content. Use the following guidelines:
134+
130135
- Use a minimum of H2 headings (with two leading `#` characters). The sections
131136
themselves are titled automatically by the template.
132137
- 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:
138143
- For `whatsnext`, give a bullet list of up to 5 topics the reader might be
139144
interested in reading next.
140145

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/).
142147

143148
## Tutorial
144149

@@ -162,6 +167,7 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
162167
| whatsnext |
163168

164169
Within each section, write your content. Use the following guidelines:
170+
165171
- Use a minimum of H2 headings (with two leading `#` characters). The sections
166172
themselves are titled automatically by the template.
167173
- For `overview`, use a paragraph to set context for the entire topic.
@@ -180,21 +186,21 @@ An example of a published tutorial topic is
180186

181187
## Reference
182188

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`.
185192

186-
Typically a tool reference page has several sections:
193+
A tool reference page has several possible sections:
187194

188195
| Page section |
189196
|------------------------------|
190197
| synopsis |
191198
| options |
192199
| options from parent commands |
193200
| examples |
194-
| body |
195201
| seealso |
196202

197-
An example of a published tool reference topic is:
203+
Examples of published tool reference pages are:
198204

199205
- [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/)
200206
- [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/)

0 commit comments

Comments
 (0)