mirror of https://github.com/knative/docs.git
Replace links to old doc templates (#4009)
This commit is contained in:
RichardJJG
GitHub
parent
201fed9daa
commit
4d52c035e2
|
|
@ -8,14 +8,18 @@ original PR. Best practice is to open a PR for the cherry-pick yourself after
|
|||
your original PR has been merged into the main branch. Once the cherry-pick PR
|
||||
has merged, remove the cherry-pick label from the original PR.
|
||||
|
||||
- [Knative contributor's guide](./help/contributing) -- lists all resources for contributing to
|
||||
Knative documentation.
|
||||
|
||||
Use one of the new content templates:
|
||||
- [Documentation](./template-docs-page.md) -- Instructions and a template that
|
||||
you can use to help you add new documentation.
|
||||
- [Blog](./template-blog-entry.md) -- Instructions and a template that
|
||||
you can use to help you post to the Knative blog.
|
||||
- [Concept](./template-concept.md) -- Conceptual topics explain how things work or what things mean.
|
||||
They provide helpful context to readers. They do not include procedures.
|
||||
- [Procedure](./template-procedure.md) -- Procedural (how-to) topics include detailed steps to
|
||||
perform a task as well as some context about the task.
|
||||
- [Troubleshooting](./template-troubleshooting.md) -- Troubleshooting topics list common errors and
|
||||
solutions.
|
||||
- [Blog](./template-blog-entry.md) -- Instructions and a template that you can use to help you post
|
||||
to the Knative blog.
|
||||
|
||||
Consult [Knative contributor's guide](./help/contributing) for all resources for contributing to
|
||||
Knative documentation.
|
||||
|
||||
Learn more about contributing to the Knative Docs:
|
||||
https://github.com/knative/docs
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@ into a single location:
|
|||
**Quick links**:
|
||||
* [Docs help](https://knative.dev/help/contributor/)
|
||||
* New content templates:
|
||||
* [Documentation](https://github.com/knative/docs/tree/main/template-docs-page.md) -- Instructions and a template that
|
||||
you can use to help you add new documentation.
|
||||
* [Blog](https://github.com/knative/docs/tree/main/template-blog-page.md) -- Instructions and a template that
|
||||
you can use to help you post to the Knative blog.
|
||||
* [Concept](template-concept.md)
|
||||
* [Procedure](template-procedure.md)
|
||||
* [Troubleshooting](template-troubleshooting.md)
|
||||
* [Blog](template-blog-entry.md)
|
||||
* [Website help](https://knative.dev/help/contributor/publishing)
|
||||
* [Maintainer help](https://knative.dev/help/maintainer/)
|
||||
|
|
|
|||
|
|
@ -14,9 +14,9 @@ into a single location:
|
|||
**Quick links**:
|
||||
* [Docs help](https://knative.dev/help/contributor/)
|
||||
* New content templates:
|
||||
* [Documentation](https://github.com/knative/docs/tree/main/template-docs-page.md) -- Instructions and a template that
|
||||
you can use to help you add new documentation.
|
||||
* [Blog](https://github.com/knative/docs/tree/main/template-blog-page.md) -- Instructions and a template that
|
||||
you can use to help you post to the Knative blog.
|
||||
* [Concept](template-concept.md)
|
||||
* [Procedure](template-procedure.md)
|
||||
* [Troubleshooting](template-troubleshooting.md)
|
||||
* [Blog](template-blog-entry.md)
|
||||
* [Website help](https://knative.dev/help/contributor/publishing)
|
||||
* [Maintainer help](https://knative.dev/help/maintainer/)
|
||||
|
|
|
|||
|
|
@ -66,10 +66,10 @@ We're excited that you're interested in contributing to the Knative documentatio
|
|||
to contribute.
|
||||
|
||||
- New content templates:
|
||||
- [Documentation](./template-docs-page.md) -- Instructions and a template that
|
||||
you can use to help you add new documentation.
|
||||
- [Blog](./template-blog-entry.md) -- Instructions and a template that
|
||||
you can use to help you post to the Knative blog.
|
||||
- [Concept](template-concept.md)
|
||||
- [Procedure](template-procedure.md)
|
||||
- [Troubleshooting](template-troubleshooting.md)
|
||||
- [Blog](template-blog-entry.md)
|
||||
|
||||
## Getting help
|
||||
|
||||
|
|
|
|||
|
|
@ -13,9 +13,9 @@ into a single location:
|
|||
**Quick links**:
|
||||
* [Docs help](https://knative.dev/help/contributor/)
|
||||
* New content templates:
|
||||
* [Documentation](https://github.com/knative/docs/tree/main/template-docs-page.md) -- Instructions and a template that
|
||||
you can use to help you add new documentation.
|
||||
* [Blog](https://github.com/knative/docs/tree/main/template-blog-page.md) -- Instructions and a template that
|
||||
you can use to help you post to the Knative blog.
|
||||
* [Concept](template-concept.md)
|
||||
* [Procedure](template-procedure.md)
|
||||
* [Troubleshooting](template-troubleshooting.md)
|
||||
* [Blog](template-blog-entry.md)
|
||||
* [Website help](https://knative.dev/help/contributor/publishing)
|
||||
* [Maintainer help](https://knative.dev/help/maintainer/)
|
||||
|
|
|
|||
|
|
@ -1,219 +0,0 @@
|
|||
# _index.md page template instructions
|
||||
|
||||
An example template with best-practices that you can use for creating a
|
||||
new `_index.md` file.
|
||||
|
||||
Generally, you only need to create a `_index.md` file if are creating a new
|
||||
folder that contains (or will contain) multiple pages. Best practice is to
|
||||
avoid creating a folder that includes only a single page.
|
||||
[Learn more about the `_index.md` file](https://gohugo.io/content-management/organization/#index-pages-_indexmd).
|
||||
|
||||
[**Copy a version of this template without the instructions**](#copy-the-template)
|
||||
|
||||
## Frontmatter
|
||||
|
||||
[Hugo](https://gohugo.io/) uses a set of metadata at the beginning of each page
|
||||
called [frontmatter](https://gohugo.io/content-management/front-matter/)
|
||||
to define website build required info as well as other blog page details.
|
||||
|
||||
Frontmatter is strict YAML syntax and must be added to the top of every
|
||||
page. Example formatting template:
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: ""
|
||||
#linkTitle: ""
|
||||
weight: 50
|
||||
type: "docs"
|
||||
showlandingtoc: "false"
|
||||
---
|
||||
```
|
||||
```
|
||||
<!--
|
||||
# This section is called the "frontmatter" for your page that is defined in YAML.
|
||||
|
||||
---
|
||||
title: ""
|
||||
# The title of this page (renders at the top of the page). Use sentence case.
|
||||
|
||||
linkTitle: ""
|
||||
# Optional: Use it to provide a shorter title for the page link so that it fits
|
||||
# in the left navigation menu (to prevent wrapping)
|
||||
|
||||
weight: ""
|
||||
# This specifies the vertical the placement of the page link in the left
|
||||
# navigation menu. Pages are ordered from top (lowest weight) to bottom (highest weight).
|
||||
|
||||
type: "docs"
|
||||
# You won't need to update this.
|
||||
|
||||
aliases:
|
||||
- /docs/example/redirect/moved-renamed-page
|
||||
- /docs/another-example
|
||||
# Optional: Specifies a URL to redirect to this page.
|
||||
# For example, has this page moved (are you replacing one or more deleted pages)?
|
||||
# If yes, include the aliases frontmatter and specify the prior location of the
|
||||
# page(s)/path(s) to redirect to this page. Specify the path and filename starting
|
||||
# from the site root (for example /docs/, /blog/, or /community/).
|
||||
|
||||
showlandingtoc: "false"
|
||||
# Required only in _index.md files
|
||||
# Defaults to "true" and renders an in-page TOC of any/all the child pages in
|
||||
# this section.
|
||||
---
|
||||
-->
|
||||
```
|
||||
```
|
||||
<!-- The page title you set in the frontmatter renders here (don't add a duplicate title) -->
|
||||
```
|
||||
```
|
||||
<!--
|
||||
The content in _index.md files generally fall into two categories (but are not
|
||||
limited to them).
|
||||
|
||||
- Use this page as a top level "landing page" that provides a high-level
|
||||
introduction to all the info covered within this section.
|
||||
- Use this page to introduce a large complex process that has multiple logical
|
||||
tasks or options.
|
||||
Examples:
|
||||
|
||||
- Use it to introduce large complex process, where each task of the process
|
||||
is covered in separate pages. Structure:
|
||||
- New-Folder
|
||||
- _index.md (introduce process)
|
||||
- before-you-begin-steps.md (prerequisites)
|
||||
- process-step1.md
|
||||
- process-step2.md
|
||||
- process-results_cleanup_whatsnext.md
|
||||
|
||||
- Use it to introduce the multiple ways to accomplish the same task, where
|
||||
each optional task is covered in separate
|
||||
pages. Structure:
|
||||
- New-Folder
|
||||
- _index.md (introduce options)
|
||||
- how-to-opt-1.md
|
||||
- how-to-opt-2.md
|
||||
- ...
|
||||
-->
|
||||
```
|
||||
|
||||
The following demonstrates a generic landing page. For more
|
||||
information about stucturing a how-to guide, see the
|
||||
[new page template instructions](./template-docs-page.md).
|
||||
|
||||
Learn how to do something very cool.
|
||||
|
||||
```
|
||||
<!--
|
||||
Make sure to state the goal of this section and the value proposition for the
|
||||
user (why is this important?).
|
||||
Example:
|
||||
Learn how to use X to reduce/improve/etc. your Y and Z.
|
||||
|
||||
Generally, make sure you answer the questions:
|
||||
- "what does this section show you how to do?"
|
||||
- "why would someone want to do this?"
|
||||
-->
|
||||
```
|
||||
|
||||
You can set `showlandingtoc:` to `"true"` and dynamically render an in-page TOC
|
||||
below the body of the text you add in this page.
|
||||
|
||||
# Copy the template
|
||||
```yaml
|
||||
---
|
||||
title: ""
|
||||
linkTitle: ""
|
||||
weight: 50
|
||||
type: "docs"
|
||||
showlandingtoc: "false"
|
||||
---
|
||||
<!--
|
||||
# This section is called the "frontmatter" for your page that is defined in YAML.
|
||||
|
||||
---
|
||||
title: ""
|
||||
# The title of this page (renders at the top of the page). Use sentence case.
|
||||
|
||||
linkTitle: ""
|
||||
# Optional: Use it to provide a shorter title for the page link so that it fits
|
||||
# in the left navigation menu (to prevent wrapping)
|
||||
|
||||
weight: ""
|
||||
# This specifies the vertical the placement of the page link in the left
|
||||
# navigation menu. Pages are ordered from top (lowest weight) to bottom (highest weight).
|
||||
|
||||
type: "docs"
|
||||
# You won't need to update this.
|
||||
|
||||
aliases:
|
||||
- /docs/example/redirect/moved-renamed-page
|
||||
- /docs/another-example
|
||||
# Optional: Specifies a URL to redirect to this page.
|
||||
# For example, has this page moved (are you replacing one or more deleted pages)?
|
||||
# If yes, include the aliases frontmatter and specify the prior location of the
|
||||
# page(s)/path(s) to redirect to this page. Specify the path and filename starting
|
||||
# from the site root (for example /docs/, /blog/, or /community/).
|
||||
|
||||
showlandingtoc: "false"
|
||||
# Required only in _index.md files
|
||||
# Defaults to "true" and renders an in-page TOC of any/all the child pages in
|
||||
# this section.
|
||||
---
|
||||
-->
|
||||
|
||||
<!-- The page title you set in the frontmatter renders here (don't add a duplicate title) -->
|
||||
|
||||
<!--
|
||||
The content in _index.md files generally fall into two categories (but are not
|
||||
limited to them).
|
||||
|
||||
- Use this page as a top level "landing page" that provides a high-level
|
||||
introduction to all the info covered within this section.
|
||||
- Use this page to introduce a large complex process that has multiple logical
|
||||
tasks or options.
|
||||
Examples:
|
||||
|
||||
- Use it to introduce large complex process, where each task of the process
|
||||
is covered in separate pages. Structure:
|
||||
- New-Folder
|
||||
- _index.md (introduce process)
|
||||
- before-you-begin-steps.md (prerequisites)
|
||||
- process-step1.md
|
||||
- process-step2.md
|
||||
- process-results_cleanup_whatsnext.md
|
||||
|
||||
- Use it to introduce the multiple ways to accomplish the same task, where
|
||||
each optional task is covered in separate
|
||||
pages. Structure:
|
||||
- New-Folder
|
||||
- _index.md (introduce options)
|
||||
- how-to-opt-1.md
|
||||
- how-to-opt-2.md
|
||||
- ...
|
||||
-->
|
||||
|
||||
<!--
|
||||
The following demonstrates a generic landing page. For more
|
||||
information about stucturing a how-to guide, see the
|
||||
[new page template instructions](./template-docs-page.md).
|
||||
-->
|
||||
|
||||
Learn how to do something very cool.
|
||||
|
||||
<!--
|
||||
Make sure to state the goal of this section and the value proposition for the
|
||||
user (why is this important?).
|
||||
Example:
|
||||
Learn how to use X to reduce/improve/etc. your Y and Z.
|
||||
|
||||
Generally, make sure you answer the questions:
|
||||
- "what does this section show you how to do?"
|
||||
- "why would someone want to do this?"
|
||||
-->
|
||||
|
||||
<!--
|
||||
You can set `showlandingtoc:` to `"true"` and dynamically render an in-page TOC
|
||||
below the body of the text you add in this page.
|
||||
-->
|
||||
```
|
||||
|
|
@ -5,29 +5,6 @@ entry to post on the Knative blog.
|
|||
|
||||
[**Copy a version of this template without the instructions**](#copy-the-template)
|
||||
|
||||
## Frontmatter
|
||||
|
||||
[Hugo](https://gohugo.io/) uses a set of metadata at the beginning of each page
|
||||
called [frontmatter](https://gohugo.io/content-management/front-matter/)
|
||||
to define website build required info as well as other blog page details.
|
||||
|
||||
Frontmatter is strict YAML syntax and must be added to the top of every
|
||||
page. Example formatting template:
|
||||
|
||||
```yaml
|
||||
---
|
||||
# This section is called the "frontmatter" for your page
|
||||
title: "Title for your page" # Use sentence case for titles and headings
|
||||
linkTitle: "A shorten title" # Optional: Use/render a shorter title in the navigation menu.
|
||||
author: "" # Your name
|
||||
authorHandle: "" # Your GitHub ID
|
||||
date: "" # Publishing date
|
||||
description: "" # A short one-liner describing this blog entry
|
||||
folderWithMediaFiles: "./images/<new-feature-name>" # The relative file path (ie. new folder) to any images, etc.
|
||||
keywords: "Releases, Steering committee, Demo, Events" # Meta keywords for the content
|
||||
---
|
||||
```
|
||||
|
||||
Include a commented-out table with tracking info about reviews and approvals:
|
||||
```
|
||||
<!--
|
||||
|
|
@ -101,17 +78,6 @@ Add a short bio of yourself here
|
|||
# Copy the template
|
||||
|
||||
```
|
||||
---
|
||||
title: ""
|
||||
linkTitle: ""
|
||||
author: ""
|
||||
authorHandle: ""
|
||||
date: ""
|
||||
description: ""
|
||||
folderWithMediaFiles: ""
|
||||
keywords: ""
|
||||
---
|
||||
|
||||
<!--
|
||||
| Reviewer | Date | Approval |
|
||||
| ------------------ | ---------- | ------------- |
|
||||
|
|
@ -119,7 +85,7 @@ keywords: ""
|
|||
| <!-- GitHub ID --> | YYYY-MM-DD | :+1:, :monocle_face:, :-1: |
|
||||
-->
|
||||
|
||||
<!-- The page title you set in the frontmatter renders here (don't add a duplicate title) -->
|
||||
# <!-- Insert blog title here -->
|
||||
|
||||
## Blog content body
|
||||
<!-- Introduce the feature you are going to explain:
|
||||
|
|
|
|||
|
|
@ -1,297 +0,0 @@
|
|||
# Documentation template instructions
|
||||
|
||||
An example template with best-practices that you can use to start drafting a new
|
||||
how-to document.
|
||||
|
||||
Use this template if you are creating a new page in an existing folder. If you
|
||||
are creating a new folder, you must also create the `_index.md`. For more
|
||||
information, see the [`_index.md` template instructions](./template-_index-page.md).
|
||||
|
||||
[**Copy a version of this template without the instructions**](#copy-the-template)
|
||||
|
||||
## Frontmatter
|
||||
|
||||
[Hugo](https://gohugo.io/) uses a set of metadata at the beginning of each page
|
||||
called [frontmatter](https://gohugo.io/content-management/front-matter/)
|
||||
to define website build required info as well as other blog page details.
|
||||
|
||||
Frontmatter is strict YAML syntax and must be added to the top of every
|
||||
page. Example formatting template:
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: ""
|
||||
#linkTitle: ""
|
||||
weight: 50
|
||||
type: "docs"
|
||||
---
|
||||
```
|
||||
```
|
||||
<!--
|
||||
# This section is called the "frontmatter" for your page that is defined in YAML.
|
||||
|
||||
title: ""
|
||||
# The title of this page (renders at the top of the page). Use sentence case.
|
||||
|
||||
linkTitle: ""
|
||||
# Optional: Use it to provide a shorter title for the page link so that it fits
|
||||
# in the left navigation menu (to prevent wrapping)
|
||||
|
||||
weight: ""
|
||||
# This specifies the vertical the placement of the page link in the left
|
||||
# navigation menu. Pages are ordered from top (lowest weight) to bottom (highest weight).
|
||||
|
||||
type: "docs"
|
||||
# You won't need to update this.
|
||||
|
||||
aliases:
|
||||
- /docs/example/redirect/moved-renamed-page
|
||||
- /docs/another-example
|
||||
# Optional: Specifies a URL to redirect to this page.
|
||||
# For example, has this page moved (are you replacing one or more deleted pages)?
|
||||
# If yes, include the aliases frontmatter and specify the prior location of the
|
||||
# page(s)/path(s) to redirect to this page. Specify the path and filename starting
|
||||
# from the site root (for example /docs/, /blog/, or /community/).
|
||||
-->
|
||||
```
|
||||
```
|
||||
<!-- The page title you set in the frontmatter renders here (don't add a duplicate title) -->
|
||||
```
|
||||
Learn how to do something very cool.
|
||||
|
||||
```
|
||||
<!--
|
||||
Make sure to state the goal of this **task-oriented
|
||||
content** and the value proposition for the user (why is this important?).
|
||||
Example:
|
||||
Learn how to use X to reduce/improve/etc. your Y and Z.
|
||||
|
||||
Generally, make sure you answer the questions:
|
||||
- "what does this guide show you how to do?"
|
||||
- "why would someone want to do this?"
|
||||
-->
|
||||
```
|
||||
|
||||
## Before you begin
|
||||
```
|
||||
<!--
|
||||
State all the requirements in this section of the document.
|
||||
Define any assumptions made (avoid tripping up the user and distracting them
|
||||
from the Knative feature you are trying to explain).
|
||||
This is where you get past any of the non-Knative items so that you can focus on
|
||||
Knative-specific stuff below. For example:
|
||||
-->
|
||||
```
|
||||
To complete the steps in this task, you must ..... meet/have/install/create/? the following:
|
||||
|
||||
- A Kubernetes cluster with [Knative installed](./docs/install/).
|
||||
<!-- Make sue to use relative links. -->
|
||||
- The latest version of ... running?
|
||||
- Privileges to .....
|
||||
- Any other requirement?
|
||||
|
||||
## Break steps into logical sections
|
||||
```
|
||||
<!--
|
||||
Avoid nesting headings directly on top of each other without text/explanation/context between.
|
||||
-->
|
||||
```
|
||||
|
||||
Introductory statement to define the goal of these steps and the role they play in this document (why its important?):
|
||||
|
||||
1. Use ordered lists for steps.
|
||||
|
||||
* Use bulleted lists for options:
|
||||
|
||||
1. Sub step one
|
||||
1. Sub step two
|
||||
|
||||
* Option two:
|
||||
|
||||
Explain the value of why a user would choose this option.
|
||||
|
||||
1. Step number two.
|
||||
|
||||
1. Step number three.
|
||||
|
||||
### Use a sub-section to group related sub-tasks
|
||||
```
|
||||
<!--
|
||||
Avoid nesting headings directly on top of each other without text/explanation/context between.
|
||||
-->
|
||||
```
|
||||
|
||||
Introductory statement to define the goal of this sub-task and why its important:
|
||||
|
||||
```
|
||||
<!--
|
||||
Put code into code blocks.
|
||||
Markdown formatting: Use spaces, not tabs to indent code blocks, and leave one
|
||||
blank line before and after the block. Examples:
|
||||
-->
|
||||
<!--
|
||||
1. Here's a code snippet:
|
||||
|
||||
```bash
|
||||
kubectl apply --filename test.yaml
|
||||
```-->
|
||||
<!--
|
||||
1. Another inline code snippet with the `kubectl apply` command.
|
||||
-->
|
||||
```
|
||||
|
||||
## Cleaning up
|
||||
```
|
||||
<!--
|
||||
If this "how-to" guide installs a sample application, creates and runs resources that might cost unnecessary fees, you should show the user how to delete or remove.
|
||||
-->
|
||||
```
|
||||
|
||||
Run the following command to stop/remove/avoid running this example and prevent incurring fees from your cloud provider/your cluster/etc.
|
||||
|
||||
## What's next
|
||||
```
|
||||
<!--
|
||||
Link to relevant topics, if applicable. Once someone has
|
||||
completed these steps, what might they want to do next?
|
||||
Remember to keep it focused and targeted, too many links are not as useful.
|
||||
-->
|
||||
```
|
||||
|
||||
Now that you have an example running, learn how to enable .....:
|
||||
|
||||
- [Link](./serving/example.md) <!-- Always use relative links if linking to a page within the Docs repo. -->
|
||||
- [Link](./eventing/example.md)
|
||||
- [Link](./search-example.md)
|
||||
|
||||
|
||||
# Copy the template
|
||||
```yaml
|
||||
---
|
||||
title: ""
|
||||
#linkTitle: ""
|
||||
weight: 50
|
||||
type: "docs"
|
||||
---
|
||||
<!--
|
||||
# This section is called the "frontmatter" for your page that is defined in YAML.
|
||||
|
||||
title: ""
|
||||
# The title of this page (renders at the top of the page). Use sentence case.
|
||||
|
||||
linkTitle: ""
|
||||
# Optional: Use it to provide a shorter title for the page link so that it fits
|
||||
# in the left navigation menu (to prevent wrapping)
|
||||
|
||||
weight: ""
|
||||
# This specifies the vertical the placement of the page link in the left
|
||||
# navigation menu. Pages are ordered from top (lowest weight) to bottom (highest weight).
|
||||
|
||||
type: "docs"
|
||||
# You won't need to update this.
|
||||
|
||||
aliases:
|
||||
- /docs/example/redirect/moved-renamed-page
|
||||
- /docs/another-example
|
||||
# Optional: Specifies a URL to redirect to this page.
|
||||
# For example, has this page moved (are you replacing one or more deleted pages)?
|
||||
# If yes, include the aliases frontmatter and specify the prior location of the
|
||||
# page(s)/path(s) to redirect to this page. Specify the path and filename starting
|
||||
# from the site root (for example /docs/, /blog/, or /community/).
|
||||
-->
|
||||
|
||||
<!-- The page title you set in the frontmatter renders here (don't add a duplicate title) -->
|
||||
|
||||
Learn how to do something very cool.
|
||||
|
||||
<!--
|
||||
Make sure to state the goal of this **task-oriented
|
||||
content** and the value proposition for the user (why is this important?).
|
||||
Example:
|
||||
Learn how to use X to reduce/improve/etc. your Y and Z.
|
||||
|
||||
Generally, make sure you answer the questions:
|
||||
- "what does this guide show you how to do?"
|
||||
- "why would someone want to do this?"
|
||||
-->
|
||||
|
||||
|
||||
## Before you begin
|
||||
<!--
|
||||
State all the requirements in this this section of the document.
|
||||
Define any assumptions made (avoid tripping up the user and distracting them from the Knative feature you are trying to explain).
|
||||
This is where you get past any of the non-Knative items so that you can focus on Knative-specific stuff below. For example:
|
||||
-->
|
||||
|
||||
To complete the steps in this task, you must ..... meet/have/install/create/? the following:
|
||||
|
||||
- A Kubernetes cluster with [Knative installed](./docs/install/).
|
||||
<!-- Make sue to use relative links. -->
|
||||
- The latest version of ... running?
|
||||
- Privileges to .....
|
||||
- Any other requirement?
|
||||
|
||||
## Break steps into logical sections
|
||||
<!--
|
||||
Avoid nesting headings directly on top of each other without text/explanation/context between.
|
||||
-->
|
||||
|
||||
Introductory statement to define the goal of these steps and the role they play in this document (why its important?):
|
||||
|
||||
1. Use ordered lists for steps.
|
||||
|
||||
* Use bulleted lists for options:
|
||||
|
||||
1. Sub step one
|
||||
1. Sub step two
|
||||
|
||||
* Option two:
|
||||
|
||||
Explain the value of why a user would choose this option.
|
||||
|
||||
1. Step number two.
|
||||
|
||||
1. Step number three.
|
||||
|
||||
### Use a sub-section to group related sub-tasks
|
||||
<!--
|
||||
Avoid nesting headings directly on top of each other without text/explanation/context between.
|
||||
-->
|
||||
|
||||
Introductory statement to define the goal of this sub-task and why its important:
|
||||
|
||||
<!--
|
||||
Put code into code blocks.
|
||||
Markdown formatting: Use spaces, not tabs to indent code blocks, and leave one blank line before and after the block.
|
||||
Examples:-->
|
||||
<!--
|
||||
1. Here's a code snippet:
|
||||
|
||||
```bash
|
||||
kubectl apply --filename test.yaml
|
||||
```-->
|
||||
<!--
|
||||
1. Another inline code snippet with the `kubectl apply` command.
|
||||
-->
|
||||
|
||||
## Cleaning up
|
||||
<!--
|
||||
If this "how-to" guide installs a sample application, creates and runs resources that might cost unnecessary fees, you should show the user how to delete or remove.
|
||||
-->
|
||||
|
||||
Run the following command to stop/remove/avoid running this example and prevent incurring fees from your cloud provider/your cluster/etc.
|
||||
|
||||
## What's next
|
||||
<!--
|
||||
Link to relevant topics, if applicable. Once someone has
|
||||
completed these steps, what might they want to do next?
|
||||
Remember to keep it focused and targeted, too many links are not as useful.
|
||||
-->
|
||||
|
||||
Now that you have an example running, learn how to enable .....:
|
||||
|
||||
- [Link](./serving/example.md) <!-- Always use relative links if linking to a page within the Docs repo. -->
|
||||
- [Link](./eventing/example.md)
|
||||
- [Link](./search-example.md)
|
||||
|
||||
```
|
||||
Loading…
Reference in New Issue