From 88fe150abc94e17472739ea3f8f85d90154dcd15 Mon Sep 17 00:00:00 2001 From: Karen Bradshaw Date: Mon, 3 Jun 2019 20:49:02 -0400 Subject: [PATCH] clean up feature state examples, style guide (#14699) --- .../contribute/style/hugo-shortcodes/index.md | 38 +++++++++---------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/content/en/docs/contribute/style/hugo-shortcodes/index.md b/content/en/docs/contribute/style/hugo-shortcodes/index.md index 986af55e87..8cd3ed1e0f 100644 --- a/content/en/docs/contribute/style/hugo-shortcodes/index.md +++ b/content/en/docs/contribute/style/hugo-shortcodes/index.md @@ -12,6 +12,7 @@ Read more about shortcodes in the [Hugo documentation](https://gohugo.io/content {{% /capture %}} {{% capture body %}} + ## 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. @@ -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 for_k8s_version shortcode parameter. -```` +``` {{}} -```` +``` Renders to: @@ -49,20 +50,19 @@ Renders to: #### Alpha feature -```` -{{}} -```` +``` +{{}} +``` Renders to: {{< feature-state state="alpha" >}} - #### Beta feature -```` -{{}} -```` +``` +{{}} +``` Renders to: @@ -70,9 +70,9 @@ Renders to: #### Stable feature -```` -{{}} -```` +``` +{{}} +``` Renders to: @@ -80,9 +80,9 @@ Renders to: #### Deprecated feature -```` -{{}} -```` +``` +{{}} +``` 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: -````liquid +```liquid {{}} -```` +``` ## Table captions @@ -235,7 +235,6 @@ Renders to: {{< tab name="JSON File" include="podtemplate" />}} {{< /tabs >}} - {{% /capture %}} {{% capture whatsnext %}} @@ -244,5 +243,4 @@ Renders to: * Learn about [using page templates](/docs/home/contribute/page-templates/). * Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/) * Learn about [creating a pull request](/docs/home/contribute/create-pull-request/). -{{% /capture %}} - +{{% /capture %}} \ No newline at end of file