Merge pull request #22301 from kbhawkey/kb-example-content-move

k8s-ci-robot · web-flow · commit 8056a69b38f8 · 2020-07-06T03:42:50.000-07:00
create archetype files, _index cleanup
diff --git a/archetypes/concepts.md b/archetypes/concepts.md
@@ -0,0 +1,12 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+content_type: concept
+---
+
+<!-- overview -->
+
+<!-- body -->
+
+<!-- Optional section; add links to information related to this topic. -->
+
+## {{% heading "whatsnext" %}}
diff --git a/archetypes/tasks.md b/archetypes/tasks.md
@@ -0,0 +1,21 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+content_type: task
+---
+
+<!-- overview -->
+
+## {{% heading "prerequisites" %}}
+
+{{< include "task-tutorial-prereqs.md" >}}
+
+<!-- If you set the min-kubernetes-server-version parameter in the page's front matter,
+    add the version check shortcode {{< version-check >}}.
+-->
+
+<!-- steps -->
+
+<!-- discussion -->
+
+<!-- Optional section; add links to information related to this topic. -->
+## {{% heading "whatsnext" %}}
diff --git a/archetypes/tutorials.md b/archetypes/tutorials.md
@@ -0,0 +1,17 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+content_type: tutorial
+---
+
+<!-- overview -->
+
+## {{% heading "prerequisites" %}}
+
+## {{% heading "objectives" %}}
+
+<!-- lessoncontent -->
+
+## {{% heading "cleanup" %}}
+
+<!-- Optional section; add links to information related to this topic. -->
+## {{% heading "whatsnext" %}}
diff --git a/content/en/docs/concepts/example-concept-template.md b/content/en/docs/concepts/example-concept-template.md
diff --git a/content/en/docs/contribute/_index.md b/content/en/docs/contribute/_index.md
@@ -3,6 +3,7 @@ content_type: concept
 title: Contribute to Kubernetes docs
 linktitle: Contribute
 main_menu: true
+no_list: true
 weight: 80
 card:
   name: contribute
@@ -23,8 +24,6 @@ Kubernetes documentation contributors:
 
 Kubernetes documentation welcomes improvements from all contributors, new and experienced!
 
-
-
 <!-- body -->
 
 ## Getting started
@@ -74,5 +73,3 @@ SIG Docs communicates with different methods:
 - Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more.
 - Read the [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet) to get involved with Kubernetes feature development.
 - Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/).
-
-
diff --git a/content/en/docs/contribute/style/write-new-topic.md b/content/en/docs/contribute/style/write-new-topic.md
@@ -28,9 +28,17 @@ Task | A task page shows how to do a single thing. The idea is to give readers a
 Tutorial | A tutorial page shows how to accomplish a goal that ties together several Kubernetes features. A tutorial might provide several sequences of steps that readers can actually do as they read the page. Or it might provide explanations of related pieces of code. For example, a tutorial could provide a walkthrough of a code sample. A tutorial can include brief explanations of the Kubernetes features that are being tied together, but should link to related concept topics for deep explanations of individual features.
 {{< /table >}}
 
+### Creating a new page
+
 Use a [content type](/docs/contribute/style/page-content-types/) for each new page
-that you write. Using page type helps ensure
-consistency among topics of a given type.
+that you write. The docs site provides templates or
+[Hugo archetypes](https://gohugo.io/content-management/archetypes/) to create
+new content pages. To create a new type of page, run `hugo new` with the path to the file
+you want to create. For example:
+
+```
+hugo new docs/concepts/my-first-concept.md
+```
 
 ## Choosing a title and filename
 
diff --git a/content/en/docs/setup/_index.md b/content/en/docs/setup/_index.md
@@ -20,35 +20,20 @@ card:
 
 <!-- overview -->
 
-This section covers different options to set up and run Kubernetes.
-
-Different Kubernetes solutions meet different requirements: ease of maintenance, security, control, available resources, and expertise required to operate and manage a cluster.
-
-You can deploy a Kubernetes cluster on a local machine, cloud, on-prem datacenter, or choose a managed Kubernetes cluster. You can also create custom solutions across a wide range of cloud providers, or bare metal environments.
-
-More simply, you can create a Kubernetes cluster in learning and production environments.
-
+This section lists the different ways to set up and run Kubernetes.
+When you install Kubernetes, choose an installation type based on: ease of maintenance, security,
+control, available resources, and expertise required to operate and manage a cluster.
 
+You can deploy a Kubernetes cluster on a local machine, cloud, on-prem datacenter, or choose a managed Kubernetes cluster. There are also custom solutions across a wide range of cloud providers, or bare metal environments.
 
 <!-- body -->
 
 ## Learning environment
 
-If you're learning Kubernetes, use the Docker-based solutions: tools supported by the Kubernetes community, or tools in the ecosystem to set up a Kubernetes cluster on a local machine.
-
-{{< table caption="Local machine solutions table that lists the tools supported by the community and the ecosystem to deploy Kubernetes." >}}
-
-|Community           |Ecosystem     |
-| ------------       | --------     |
-| [Minikube](/docs/setup/learning-environment/minikube/) | [Docker Desktop](https://www.docker.com/products/docker-desktop)|
-| [kind (Kubernetes IN Docker)](/docs/setup/learning-environment/kind/) | [Minishift](https://docs.okd.io/latest/minishift/)|
-|                     | [MicroK8s](https://microk8s.io/)|
-
+If you're learning Kubernetes, use the tools supported by the Kubernetes community, or tools in the ecosystem to set up a Kubernetes cluster on a local machine.
 
 ## Production environment
 
 When evaluating a solution for a production environment, consider which aspects of operating a Kubernetes cluster (or _abstractions_) you want to manage yourself or offload to a provider.
 
 [Kubernetes Partners](https://kubernetes.io/partners/#conformance) includes a list of [Certified Kubernetes](https://github.com/cncf/k8s-conformance/#certified-kubernetes) providers.
-
-
diff --git a/content/en/docs/tasks/_index.md b/content/en/docs/tasks/_index.md
@@ -11,9 +11,5 @@ This section of the Kubernetes documentation contains pages that
 show how to do individual tasks. A task page shows how to do a
 single thing, typically by giving a short sequence of steps.
 
-
-## {{% heading "whatsnext" %}}
-
-
 If you would like to write a task page, see
 [Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/).
diff --git a/content/en/docs/tasks/example-task-template.md b/content/en/docs/tasks/example-task-template.md
diff --git a/content/en/docs/tutorials/_index.md b/content/en/docs/tutorials/_index.md
@@ -1,6 +1,7 @@
 ---
 title: Tutorials
 main_menu: true
+no_list: true
 weight: 60
 content_type: concept
 ---
@@ -14,8 +15,6 @@ each of which has a sequence of steps.
 Before walking through each tutorial, you may want to bookmark the
 [Standardized Glossary](/docs/reference/glossary/) page for later references.
 
-
-
 <!-- body -->
 
 ## Basics
@@ -64,13 +63,8 @@ Before walking through each tutorial, you may want to bookmark the
 
 * [Using Source IP](/docs/tutorials/services/source-ip/)
 
-
-
 ## {{% heading "whatsnext" %}}
 
-
 If you would like to write a tutorial, see
 [Content Page Types](/docs/contribute/style/page-content-types/)
 for information about the tutorial page type.
-
-
