Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 3.12 KB

new-page-template.md

File metadata and controls

88 lines (63 loc) · 3.12 KB
Raw

Documentation Template

This page is intended to provide best-practices for starting a new document.

Frontmatter

Hugo uses a set of metadata at the beginning of the page called frontmatter to indicate information like the page title and link rendering in the sidebar.

Frontmatter needs to be formatted like this:

---
# This section is called the "frontmatter" for your page
title: "Title for your page" # Use sentence case for titles
linkTitle: "Template: New docs page"
# The linkTitle field (above) is optional; use it to provide a shorter link if your page title is very long
weight: 50 # 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:

Break steps into logical sections

Avoid nesting headings directly on top of each other with no text in between.

  1. Use ordered lists for steps.

  2. Step number two.

  3. 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 in between.

Put code into a code block.

  1. Here's a code snippet:

    kubectl apply --filename test.yaml

  2. Another code snippet:

    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?