From d55153a79e5316809d1e50926b29f3dafd02b5b0 Mon Sep 17 00:00:00 2001 From: RichardJJG Date: Thu, 15 Jul 2021 16:22:50 +0100 Subject: [PATCH 01/18] Culled old contributor docs --- .../contributor/becoming-a-contributor.md | 9 +- .../help/contributor/code-samples.md | 7 +- .../help/contributor/creating-blog-posts.md | 2 + .../help/contributor/creating-new-docs.md | 49 ++--- .../help/contributor}/github.md | 22 ++- .../help/contributor}/structure.md | 7 +- help/README.md | 20 -- help/contributor/_index.md | 10 - help/contributor/how-to/_index.md | 7 - help/contributor/how-to/formatting.md | 113 ----------- help/contributor/how-to/frontmatter.md | 118 ----------- help/contributor/how-to/shortcodes.md | 56 ------ help/contributor/how-to/styleguide.md | 116 ----------- help/contributor/new-blog/blog-page.md | 10 - help/contributor/new-docs/docs-page.md | 10 - help/contributor/new-docs/index-page.md | 10 - help/contributor/publishing.md | 187 ------------------ help/faqs.md | 26 --- 18 files changed, 41 insertions(+), 738 deletions(-) rename help/contributor/gettingstarted.md => docs/help/contributor/becoming-a-contributor.md (98%) rename help/contributor/how-to/codesamples.md => docs/help/contributor/code-samples.md (98%) rename help/contributor/new-blog/_index.md => docs/help/contributor/creating-blog-posts.md (99%) rename help/contributor/new-docs/_index.md => docs/help/contributor/creating-new-docs.md (87%) rename {help/contributor/how-to => docs/help/contributor}/github.md (91%) rename {help/contributor/how-to => docs/help/contributor}/structure.md (98%) delete mode 100644 help/README.md delete mode 100644 help/contributor/_index.md delete mode 100644 help/contributor/how-to/_index.md delete mode 100644 help/contributor/how-to/formatting.md delete mode 100644 help/contributor/how-to/frontmatter.md delete mode 100644 help/contributor/how-to/shortcodes.md delete mode 100644 help/contributor/how-to/styleguide.md delete mode 100644 help/contributor/new-blog/blog-page.md delete mode 100644 help/contributor/new-docs/docs-page.md delete mode 100644 help/contributor/new-docs/index-page.md delete mode 100644 help/contributor/publishing.md delete mode 100644 help/faqs.md diff --git a/help/contributor/gettingstarted.md b/docs/help/contributor/becoming-a-contributor.md similarity index 98% rename from help/contributor/gettingstarted.md rename to docs/help/contributor/becoming-a-contributor.md index dd894ad16fa..dce9fc05274 100644 --- a/help/contributor/gettingstarted.md +++ b/docs/help/contributor/becoming-a-contributor.md @@ -1,11 +1,4 @@ ---- -title: "Joining the project and getting started" -linkTitle: "Join" -weight: 10 -type: "docs" ---- - - +# Becoming a contributor ## Join to become a contributor diff --git a/help/contributor/how-to/codesamples.md b/docs/help/contributor/code-samples.md similarity index 98% rename from help/contributor/how-to/codesamples.md rename to docs/help/contributor/code-samples.md index 20a86e77de4..b5304d8896a 100644 --- a/help/contributor/how-to/codesamples.md +++ b/docs/help/contributor/code-samples.md @@ -1,9 +1,4 @@ ---- -title: "Code samples" -linkTitle: "" -weight: 100 -type: "docs" ---- +# Code samples There are currently two general types of content that focus on code samples, either internal contributor content, or external-facing user content. diff --git a/help/contributor/new-blog/_index.md b/docs/help/contributor/creating-blog-posts.md similarity index 99% rename from help/contributor/new-blog/_index.md rename to docs/help/contributor/creating-blog-posts.md index 2b6f889a4ce..8b937c99e6c 100644 --- a/help/contributor/new-blog/_index.md +++ b/docs/help/contributor/creating-blog-posts.md @@ -6,6 +6,8 @@ type: "docs" showlandingtoc: "false" --- +# Creating blog posts + The Knative blog is owned by the [Documentation working group](https://knative.dev/community/contributing/working-groups/working-groups/#documentation) and run by the [Editorial Team](#leadership). This section covers documentation, processes, and roles for the [Knative blog](https://knative.dev/blog/). diff --git a/help/contributor/new-docs/_index.md b/docs/help/contributor/creating-new-docs.md similarity index 87% rename from help/contributor/new-docs/_index.md rename to docs/help/contributor/creating-new-docs.md index bbcf9a51576..8a3f85555c5 100644 --- a/help/contributor/new-docs/_index.md +++ b/docs/help/contributor/creating-new-docs.md @@ -1,20 +1,13 @@ ---- -title: "Adding new documentation" -linkTitle: "New docs" -weight: 20 -type: "docs" -showlandingtoc: "false" ---- +# Creating new documentation To contribute new documentation, follow these steps: 1. Identify the audience and intended use for the information. 1. Choose the [type of content](#content-types) you wish to contribute. 1. You can use a template to get started: - * [New docs file](./docs-page.md) - * [New `_index.md` file](./index-page.md) + [insert links to new templates] 1. [Choose appropriate titles and filenames](#choosing-titles-and-filenames). -1. Write your new content. See the [How-to guides](/help/contributor/how-to/) +1. Write your new content. See [insert link to style guide] to help you with this process. Feel free to reach out to the [Docs Working Group](/help/contributor/gettingstarted.md#get-help-from-the-community) with any questions. @@ -31,7 +24,7 @@ structure, or the necessary supporting information. The following examples show this principle in action: - The reader needs to perform a specific task: Tell them how to recognize when - the task is necessary and provide the task itself as a list of numbered steps, + the task is necessary and provide the task itself as a list of numbered steps; don’t simply describe the task in general terms. - The reader must understand a concept before they can perform a task: Before @@ -58,8 +51,8 @@ giving readers all the information you have, because you are unsure about what information they need. If you need help identifying the audience for you content, we are happy to help -and answer all your questions during the [Docs Working Group](https://github.com/knative/community/blob/main/working-groups/WORKING-GROUPS.md) -biweekly meetings. +and answer all your questions during the [DUX](https://github.com/knative/community/blob/main/working-groups/WORKING-GROUPS.md) +weekly meetings. ## Content types @@ -77,7 +70,7 @@ their intended audiences, and the goals each type strives to achieve: - Concepts + Concept Explain some significant aspect of Knative. For example, a concept page describes the configuration model of a feature and explains its functionality. Concept pages don't include sequences of steps. Instead, provide links to @@ -86,7 +79,7 @@ their intended audiences, and the goals each type strives to achieve: knowledge of the project. - Reference pages + Reference Provide exhaustive and detailed technical information. Common examples include API parameters, command-line options, configuration settings, and advanced procedures. Reference content is generated from the Knative code @@ -96,7 +89,7 @@ their intended audiences, and the goals each type strives to achieve: needs specific bits of information to complete advanced tasks. - Examples + Example Describe a working and stand-alone example that highlights a set of features, an integration of Knative with other projects, or an end-to-end solution for a use case. Examples must use an existing Knative setup as a @@ -107,23 +100,23 @@ their intended audiences, and the goals each type strives to achieve: to produce their own solutions. - Tasks - Shows how to achieve a single goal using Knative features. Tasks contain procedures written - as a sequence of steps. Tasks provide minimal + Procedure + Shows how to achieve a single goal using Knative features. Procedures are written + as a sequence of steps. Procedures provide minimal explanation of the features, but include links to the concepts that - provide the related background and knowledge. Tasks must include automated + provide the related background and knowledge. Procedures must include automated tests since they are tested and maintained for technical accuracy. Readers that want to use Knative features. - Setup pages + Setup Focus on the installation steps needed to complete an Knative deployment. Setup pages must include automated tests since they are tested and maintained for technical accuracy. New and existing Knative users that want to complete a deployment. - Blog posts + Blog Focus on Knative or products and technologies related to it. Blog posts fall in one of the following three categories: