From 51337a063c438f1376533a7a8f3e5d883731fb76 Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Fri, 12 Mar 2021 12:57:35 -0800 Subject: [PATCH] Add links to new content templates (#531) * Add links to new content templates * remove duplicate --- docs/README.md | 8 +++-- docs/new-page-template.md | 73 --------------------------------------- 2 files changed, 5 insertions(+), 76 deletions(-) delete mode 100644 docs/new-page-template.md diff --git a/docs/README.md b/docs/README.md index aef5762..9a65374 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,6 +16,8 @@ documentation! Check out the resources below to get started. is the best place to go if you have questions about making changes to the documentation. We're happy to help! -- [Documentation working group](../working-groups/WORKING-GROUPS.md#documentation) - -- Come join us in the working group to meet other docs contributors and ask - any questions you might have. +- Use one of the new content templates: + - [Documenation](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-entry.md) -- Instructions and a template that + you can use to help you post to the Knative blog. diff --git a/docs/new-page-template.md b/docs/new-page-template.md deleted file mode 100644 index f309d0b..0000000 --- a/docs/new-page-template.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -# 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: - -- 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)