fix link, edit content
This commit is contained in:
@@ -16,35 +16,39 @@ The Kubernetes documentation follows several types of page content:
|
|||||||
- Tutorial
|
- Tutorial
|
||||||
- Reference
|
- Reference
|
||||||
|
|
||||||
Content pages contain HTML headings that create structure on the page.
|
|
||||||
|
|
||||||
<!-- body -->
|
<!-- body -->
|
||||||
|
|
||||||
## Content sections
|
## Content sections
|
||||||
|
|
||||||
Each page content type contains a number of sections.
|
Each page content type contains a number of sections declared as
|
||||||
Most of the main sections are outlined in the page using Markdown comments.
|
Markdown comments and HTML headings. HTML section headings render using the
|
||||||
This page structure helps to maintain the different content types.
|
`heading` shortcode. This page structure helps to maintain the different content types.
|
||||||
|
|
||||||
For example,
|
Examples of Markdown comments defining page content sections:
|
||||||
|
|
||||||
```
|
```markdown
|
||||||
<!-- body -->
|
<!-- body -->
|
||||||
```
|
```
|
||||||
|
|
||||||
```
|
```markdown
|
||||||
<!-- overview -->
|
<!-- overview -->
|
||||||
```
|
```
|
||||||
|
|
||||||
To create localized headings for common headings, use the `heading` shortcode
|
To create common headings in your content pages, use the `heading` shortcode with
|
||||||
in your content pages. Common localized headings are:
|
a heading string.
|
||||||
|
|
||||||
|
Examples of heading strings:
|
||||||
|
|
||||||
- whatsnext
|
- whatsnext
|
||||||
- prerequisites
|
- prerequisites
|
||||||
- objectives
|
- objectives
|
||||||
- cleanup
|
- cleanup
|
||||||
|
- synopsis
|
||||||
|
- seealso
|
||||||
|
- options
|
||||||
|
|
||||||
To create a localized `whatsnext` heading on a page, you can add to your page:
|
To create a `whatsnext` heading, add the heading shortcode
|
||||||
|
to your page as follows:
|
||||||
|
|
||||||
```none
|
```none
|
||||||
## {{%/* heading "whatsnext" */%}}
|
## {{%/* heading "whatsnext" */%}}
|
||||||
@@ -54,29 +58,29 @@ The `whatsnext` heading displays as:
|
|||||||
|
|
||||||
## {{% heading "whatsnext" %}}
|
## {{% heading "whatsnext" %}}
|
||||||
|
|
||||||
|
You can declare a `prerequisites` heading as:
|
||||||
To create a localized `prerequisites` heading on a page, you can add to your page:
|
|
||||||
|
|
||||||
```none
|
```none
|
||||||
## {{%/* heading "prerequisites" */%}}
|
## {{%/* heading "prerequisites" */%}}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `prerequisites heading displays as:
|
The `prerequisites` heading displays as:
|
||||||
|
|
||||||
## {{% heading "prerequisites" %}}
|
## {{% heading "prerequisites" %}}
|
||||||
|
|
||||||
|
The `heading` shortcode takes one string parameter. The string matches the prefix
|
||||||
|
of a variable in the `i18n/<lang>.toml` files.
|
||||||
|
|
||||||
The `heading` shortcode takes one parameter.
|
`i18n/en.toml`:
|
||||||
The string should match the prefix of a variable in the localized file, such `i18n/en.toml`:
|
|
||||||
|
|
||||||
```
|
```toml
|
||||||
[whatsnext_heading]
|
[whatsnext_heading]
|
||||||
other = "What's next"
|
other = "What's next"
|
||||||
```
|
```
|
||||||
|
|
||||||
Another localized file, such as `i18n/ko.toml`:
|
`i18n/ko.toml`:
|
||||||
|
|
||||||
```
|
```toml
|
||||||
[whatsnext_heading]
|
[whatsnext_heading]
|
||||||
other = "다음 내용"
|
other = "다음 내용"
|
||||||
```
|
```
|
||||||
@@ -100,8 +104,8 @@ Concept pages are divided into three sections:
|
|||||||
| body |
|
| body |
|
||||||
| whatsnext |
|
| whatsnext |
|
||||||
|
|
||||||
|
|
||||||
Fill each section with content. Follow these guidelines:
|
Fill each section with content. Follow these guidelines:
|
||||||
|
|
||||||
- Organize content with H2 and H3 headings.
|
- Organize content with H2 and H3 headings.
|
||||||
- For `overview`, set the topic's context with a single paragraph.
|
- For `overview`, set the topic's context with a single paragraph.
|
||||||
- For `body`, explain the concept.
|
- For `body`, explain the concept.
|
||||||
@@ -127,6 +131,7 @@ To write a new task page, create a Markdown file in a subdirectory of the
|
|||||||
| whatsnext |
|
| whatsnext |
|
||||||
|
|
||||||
Within each section, write your content. Use the following guidelines:
|
Within each section, write your content. Use the following guidelines:
|
||||||
|
|
||||||
- Use a minimum of H2 headings (with two leading `#` characters). The sections
|
- Use a minimum of H2 headings (with two leading `#` characters). The sections
|
||||||
themselves are titled automatically by the template.
|
themselves are titled automatically by the template.
|
||||||
- For `overview`, use a paragraph to set context for the entire topic.
|
- 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:
|
|||||||
- For `whatsnext`, give a bullet list of up to 5 topics the reader might be
|
- For `whatsnext`, give a bullet list of up to 5 topics the reader might be
|
||||||
interested in reading next.
|
interested in reading next.
|
||||||
|
|
||||||
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).
|
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/).
|
||||||
|
|
||||||
## Tutorial
|
## Tutorial
|
||||||
|
|
||||||
@@ -162,6 +167,7 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
|
|||||||
| whatsnext |
|
| whatsnext |
|
||||||
|
|
||||||
Within each section, write your content. Use the following guidelines:
|
Within each section, write your content. Use the following guidelines:
|
||||||
|
|
||||||
- Use a minimum of H2 headings (with two leading `#` characters). The sections
|
- Use a minimum of H2 headings (with two leading `#` characters). The sections
|
||||||
themselves are titled automatically by the template.
|
themselves are titled automatically by the template.
|
||||||
- For `overview`, use a paragraph to set context for the entire topic.
|
- For `overview`, use a paragraph to set context for the entire topic.
|
||||||
@@ -180,10 +186,11 @@ An example of a published tutorial topic is
|
|||||||
|
|
||||||
## Reference
|
## Reference
|
||||||
|
|
||||||
A component tool reference page shows the `--help` output for a Kubernetes component tool.
|
A component tool reference page shows the description and flag options output for
|
||||||
Each page output depends upon the component tool's source code in `kubernetes/kubernetes`.
|
a Kubernetes component tool. Each page output depends upon the component tool's source
|
||||||
|
code in `kubernetes/kubernetes`.
|
||||||
|
|
||||||
Typically a tool reference page has several sections:
|
A tool reference page has several possible sections:
|
||||||
|
|
||||||
| Page section |
|
| Page section |
|
||||||
|------------------------------|
|
|------------------------------|
|
||||||
@@ -191,10 +198,9 @@ Typically a tool reference page has several sections:
|
|||||||
| options |
|
| options |
|
||||||
| options from parent commands |
|
| options from parent commands |
|
||||||
| examples |
|
| examples |
|
||||||
| body |
|
|
||||||
| seealso |
|
| seealso |
|
||||||
|
|
||||||
An example of a published tool reference topic is:
|
Examples of published tool reference pages are:
|
||||||
|
|
||||||
- [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/)
|
- [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/)
|
||||||
- [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/)
|
- [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/)
|
||||||
|
|||||||
Reference in New Issue
Block a user