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

create archetype files, _index cleanup
This commit is contained in:
Kubernetes Prow Robot
2020-07-06 03:42:50 -07:00
committed by GitHub
10 changed files with 67 additions and 130 deletions
+12
View File
@@ -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" %}}
+21
View File
@@ -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" %}}
+17
View File
@@ -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" %}}
@@ -1,41 +0,0 @@
---
title: Example Concept Template
reviewers:
- chenopis
content_type: concept
toc_hide: true
---
<!-- overview -->
{{< note >}}
Be sure to also [create an entry in the table of contents](/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents) for your new document.
{{< /note >}}
This page explains ...
<!-- body -->
## Understanding ...
Kubernetes provides ...
## Using ...
To use ...
## {{% heading "whatsnext" %}}
**[Optional Section]**
* Learn more about [Writing a New Topic](/docs/home/contribute/style/write-new-topic/).
* See [Page Content Types - Concept](/docs/home/contribute/style/page-concept-types/#concept).
+1 -4
View File
@@ -3,6 +3,7 @@ content_type: concept
title: Contribute to Kubernetes docs title: Contribute to Kubernetes docs
linktitle: Contribute linktitle: Contribute
main_menu: true main_menu: true
no_list: true
weight: 80 weight: 80
card: card:
name: contribute name: contribute
@@ -23,8 +24,6 @@ Kubernetes documentation contributors:
Kubernetes documentation welcomes improvements from all contributors, new and experienced! Kubernetes documentation welcomes improvements from all contributors, new and experienced!
<!-- body --> <!-- body -->
## Getting started ## 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. - 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. - 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/). - Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/).
@@ -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. 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 >}} {{< /table >}}
### Creating a new page
Use a [content type](/docs/contribute/style/page-content-types/) for each new page Use a [content type](/docs/contribute/style/page-content-types/) for each new page
that you write. Using page type helps ensure that you write. The docs site provides templates or
consistency among topics of a given type. [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 ## Choosing a title and filename
+5 -20
View File
@@ -20,35 +20,20 @@ card:
<!-- overview --> <!-- overview -->
This section covers different options to set up and run Kubernetes. 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,
Different Kubernetes solutions meet different requirements: ease of maintenance, security, control, available resources, and expertise required to operate and manage a cluster. 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.
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 --> <!-- body -->
## Learning environment ## 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. 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.
{{< 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/)|
## Production environment ## 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. 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. [Kubernetes Partners](https://kubernetes.io/partners/#conformance) includes a list of [Certified Kubernetes](https://github.com/cncf/k8s-conformance/#certified-kubernetes) providers.
-4
View File
@@ -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 show how to do individual tasks. A task page shows how to do a
single thing, typically by giving a short sequence of steps. single thing, typically by giving a short sequence of steps.
## {{% heading "whatsnext" %}}
If you would like to write a task page, see If you would like to write a task page, see
[Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/). [Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/).
@@ -1,52 +0,0 @@
---
title: Example Task Template
reviewers:
- chenopis
content_type: task
toc_hide: true
---
<!-- overview -->
{{< note >}}
Be sure to also [create an entry in the table of contents](/docs/contribute/style/write-new-topic/#placing-your-topic-in-the-table-of-contents) for your new document.
{{< /note >}}
This page shows how to ...
## {{% heading "prerequisites" %}}
* {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}
* Do this.
* Do this too.
<!-- steps -->
## Doing ...
1. Do this.
1. Do this next. Possibly read this [related explanation](#).
<!-- discussion -->
## Understanding ...
**[Optional Section]**
Here's an interesting thing to know about the steps you just did.
## {{% heading "whatsnext" %}}
**[Optional Section]**
* Learn more about [Writing a New Topic](/docs/home/contribute/write-new-topic/).
* Learn about [Page Content Types - Task](/docs/home/contribute/style/page-content-types/#task).
+1 -7
View File
@@ -1,6 +1,7 @@
--- ---
title: Tutorials title: Tutorials
main_menu: true main_menu: true
no_list: true
weight: 60 weight: 60
content_type: concept 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 Before walking through each tutorial, you may want to bookmark the
[Standardized Glossary](/docs/reference/glossary/) page for later references. [Standardized Glossary](/docs/reference/glossary/) page for later references.
<!-- body --> <!-- body -->
## Basics ## Basics
@@ -64,13 +63,8 @@ Before walking through each tutorial, you may want to bookmark the
* [Using Source IP](/docs/tutorials/services/source-ip/) * [Using Source IP](/docs/tutorials/services/source-ip/)
## {{% heading "whatsnext" %}} ## {{% heading "whatsnext" %}}
If you would like to write a tutorial, see If you would like to write a tutorial, see
[Content Page Types](/docs/contribute/style/page-content-types/) [Content Page Types](/docs/contribute/style/page-content-types/)
for information about the tutorial page type. for information about the tutorial page type.