From 07bb06531b9a0643a55672194a4a25f34301f49e Mon Sep 17 00:00:00 2001 From: Sam O'Dell <31352624+samodell@users.noreply.github.com> Date: Mon, 18 Nov 2019 15:06:07 -0800 Subject: [PATCH] Template for new Docs pages (#1986) * adding a template for new docs pages * update to template * feedback * Apply suggestions from code review Co-Authored-By: RichieEscarez --- contributing/new-page-template.md | 73 +++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 contributing/new-page-template.md diff --git a/contributing/new-page-template.md b/contributing/new-page-template.md new file mode 100644 index 000000000..f8edeb867 --- /dev/null +++ b/contributing/new-page-template.md @@ -0,0 +1,73 @@ +--- +# This section is called the "frontmatter" for your page +title: "Title for your page" # Use sentence case for titles +#linkTitle: "Link for this page in the sidebar" +# The linkTitle field (above) is optional; use it to provide a shorter link if your page title is very long +weight: 10 # This affects the placement of the link in the sidebar on the left. Pages are ordered from top to bottom by weight, lowest to highest. +type: "docs" # You won't need to update this. +#aliases: +# - /docs/example/redirect/moved-renamed-page +# - /docs/another-example +# Has the page ever moved? If yes, include the prior location above, starting with path from the site root (for example /docs/, /blog/, or /community/). The old URL will redirect to this new file. For a new pages, "aliases" are not required. +--- + +This guide shows you how to do something very cool. Make sure to include +a value proposition for the user: for example, this guide shows you how to do X, +which is useful for doing Y and Z. Make sure you answer the questions "what does +this guide show you how to do?" and "why would someone want to do this?". + +## Before you begin + +You need: + +- A Kubernetes cluster with [Knative installed](../install/README.md). +- Anything else? + +## Break steps into logical sections + +Avoid nesting headings directly on top of each other with no text inbetween. + +1. Use ordered lists for steps. + +1. Step number two. + +1. Step number three. + + + +### You can use smaller sections within sections for related tasks + +Avoid nesting headings directly on top of each other with no text inbetween. + +Put code into a code block. + +1. Here's a code snippet: + + ```bash + kubectl apply --filename test.yaml + ``` +1. Another code snippet: + + ```bash + kubectl apply --filename test2.yaml + ``` + +Always explain code snippets thoroughly so that how they work or what they do +is clear. + +## Cleaning up + +If your guide installs a sample application, show the user how to delete it. + +## What's next + +Provide links to other relevant topics, if applicable. Once someone has +completed these steps, what might they want to do next? + +- [Link](./page.md) +- [Link](./page.md) +- [Link](./page.md)