clean up feature state examples, style guide (#14699)
This commit is contained in:
parent
e66b9a542a
commit
88fe150abc
|
|
@ -12,6 +12,7 @@ Read more about shortcodes in the [Hugo documentation](https://gohugo.io/content
|
||||||
{{% /capture %}}
|
{{% /capture %}}
|
||||||
|
|
||||||
{{% capture body %}}
|
{{% capture body %}}
|
||||||
|
|
||||||
## Feature state
|
## Feature state
|
||||||
|
|
||||||
In a markdown page (`.md` file) on this site, you can add a shortcode to display version and state of the documented feature.
|
In a markdown page (`.md` file) on this site, you can add a shortcode to display version and state of the documented feature.
|
||||||
|
|
@ -39,9 +40,9 @@ The valid values for `state` are:
|
||||||
|
|
||||||
The displayed Kubernetes version defaults to that of the page or the site. This can be changed by passing the <code>for_k8s_version</code> shortcode parameter.
|
The displayed Kubernetes version defaults to that of the page or the site. This can be changed by passing the <code>for_k8s_version</code> shortcode parameter.
|
||||||
|
|
||||||
````
|
```
|
||||||
{{</* feature-state for_k8s_version="v1.10" state="stable" */>}}
|
{{</* feature-state for_k8s_version="v1.10" state="stable" */>}}
|
||||||
````
|
```
|
||||||
|
|
||||||
Renders to:
|
Renders to:
|
||||||
|
|
||||||
|
|
@ -49,20 +50,19 @@ Renders to:
|
||||||
|
|
||||||
#### Alpha feature
|
#### Alpha feature
|
||||||
|
|
||||||
````
|
```
|
||||||
{{</* feature-state feature-state state="alpha" */>}}
|
{{</* feature-state state="alpha" */>}}
|
||||||
````
|
```
|
||||||
|
|
||||||
Renders to:
|
Renders to:
|
||||||
|
|
||||||
{{< feature-state state="alpha" >}}
|
{{< feature-state state="alpha" >}}
|
||||||
|
|
||||||
|
|
||||||
#### Beta feature
|
#### Beta feature
|
||||||
|
|
||||||
````
|
```
|
||||||
{{</* feature-state feature-state state="beta" */>}}
|
{{</* feature-state state="beta" */>}}
|
||||||
````
|
```
|
||||||
|
|
||||||
Renders to:
|
Renders to:
|
||||||
|
|
||||||
|
|
@ -70,9 +70,9 @@ Renders to:
|
||||||
|
|
||||||
#### Stable feature
|
#### Stable feature
|
||||||
|
|
||||||
````
|
```
|
||||||
{{</* feature-state feature-state state="stable" */>}}
|
{{</* feature-state state="stable" */>}}
|
||||||
````
|
```
|
||||||
|
|
||||||
Renders to:
|
Renders to:
|
||||||
|
|
||||||
|
|
@ -80,9 +80,9 @@ Renders to:
|
||||||
|
|
||||||
#### Deprecated feature
|
#### Deprecated feature
|
||||||
|
|
||||||
````
|
```
|
||||||
{{</* feature-state feature-state state="deprecated" */>}}
|
{{</* feature-state state="deprecated" */>}}
|
||||||
````
|
```
|
||||||
|
|
||||||
Renders to:
|
Renders to:
|
||||||
|
|
||||||
|
|
@ -99,9 +99,9 @@ The raw data for glossary terms is stored at [https://github.com/kubernetes/webs
|
||||||
|
|
||||||
For example, the following include within the markdown renders to {{< glossary_tooltip text="cluster" term_id="cluster" >}} with a tooltip:
|
For example, the following include within the markdown renders to {{< glossary_tooltip text="cluster" term_id="cluster" >}} with a tooltip:
|
||||||
|
|
||||||
````liquid
|
```liquid
|
||||||
{{</* glossary_tooltip text="cluster" term_id="cluster" */>}}
|
{{</* glossary_tooltip text="cluster" term_id="cluster" */>}}
|
||||||
````
|
```
|
||||||
|
|
||||||
## Table captions
|
## Table captions
|
||||||
|
|
||||||
|
|
@ -235,7 +235,6 @@ Renders to:
|
||||||
{{< tab name="JSON File" include="podtemplate" />}}
|
{{< tab name="JSON File" include="podtemplate" />}}
|
||||||
{{< /tabs >}}
|
{{< /tabs >}}
|
||||||
|
|
||||||
|
|
||||||
{{% /capture %}}
|
{{% /capture %}}
|
||||||
|
|
||||||
{{% capture whatsnext %}}
|
{{% capture whatsnext %}}
|
||||||
|
|
@ -244,5 +243,4 @@ Renders to:
|
||||||
* Learn about [using page templates](/docs/home/contribute/page-templates/).
|
* Learn about [using page templates](/docs/home/contribute/page-templates/).
|
||||||
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/)
|
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/)
|
||||||
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
|
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
|
||||||
{{% /capture %}}
|
{{% /capture %}}
|
||||||
|
|
||||||
Loading…
Reference in New Issue