Quickstart template and example

docs-standards/10-structure-the-content/01-document-types/quickstart-help-me-get-started.md

@@ -85,7 +85,7 @@ This information-type [admonition](../../20-style-the-content/12-admonitions.md)
 Guidelines:
 
 - Use the "Overview" H2 heading for this section.
-- Start with a brief discussion of this product or feature and its core purposes. Then describe what the user can accomplish in this quickstart.
+- Start with what the user can accomplish in this quickstart. Then add a brief discussion of this product or feature and its core purposes.
 - The overview should be one or a maximum of two paragraphs. Use an additional [concept](./concept-help-me-to-understand.md) article if you need to provide more information.
 - Link to related topics to support the reader's gathering of information.
 

examples/quickstart-example.md

@@ -0,0 +1,99 @@
+---
+title: Quickstart
+topic: Repositories
+author: jorge-campo, cheny0
+version: 1
+url: docs/repositories/quickstart
+---
+
+<!-- This document is an example for the concept template. It is not a real document and should be used for illustration purposes only. -->
+
+# Quickstart
+
+#### Create and manage your first repository quickly.
+
+> 📒 **Note**  
+> You can create repositories in your personal account or any organization where you have the required permissions.
+
+## Overview
+
+In this quickstart, you create a repository, edit a file, and clone the repository to your computer. This helps you begin collaborating or versioning your code immediately.
+
+Repositories are project containers on GitHub. They store source code, configuration, and related files.
+
+## Before you start
+
+Before you begin, make sure you have:
+
+- A GitHub personal or organization [account](https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts)
+- [Git command line tool](https://git-scm.com/)
+
+## Create a repository
+
+1. In the upper-right corner of any GitHub page, click **+** and choose **New repository**.  
+    ![An image showing the new repository option](./quickstart-example/create-a-repository-step-1.png)
+2. Enter a repository name.  
+3. Optionally, add a description.  
+4. For **Choose visibility**, select **Public** or **Private**.
+5. Click the toggle to include add a README.
+6. Click **Create repository**.   
+
+## Commit a change to the README
+
+A [commit](https://docs.github.com/en/get-started/learning-about-github/github-glossary#commit) is like a snapshot of all the files in your project at a particular point in time. Committing a change means to save your changes to the repository.
+
+### Edit the README
+
+1. In the upper-right corner of any GitHub page, click your profile picture, and then click **Your repositories**.
+2. Click your repository name.
+3. In your repository's list of files, select `README.md`.
+    ![An image showing the README.md file in the file list](./quickstart-example/edit-the-readme-step-3.png)
+4. In the upper right corner of the file view, click ![Edit icon](./quickstart-example/edit-icon.png) to open the file editor.
+5. In the text box, type some information about your project.
+6. Above the new content, click **Preview**.
+7. Review the changes you made to the file. If you select **Show diff**, you will see the new content in green.
+
+### Commit the change
+
+1. Click **Commit changes...**
+2. In the **Commit message** field, type a short, meaningful commit message that describes the change you made to the file.
+3. Select **Commit directly to the main branch**.
+4. Click **Commit changes**.
+
+## Clone the repository locally
+
+Cloning a repository from GitHub.com to your local computer makes it easier to fix merge conflicts, add or remove files, and push larger commits.
+
+### Copy the URL
+
+1. In the upper-right corner of any GitHub page, click your profile picture, and then click **Your repositories**.
+2. Click your repository name.
+3. Above the list of files, click **<> Code**.
+4. Under **HTTPS**, click ![Copy icon](./quickstart-example/copy-icon.png).
+
+### Clone the repository
+
+1. Open a terminal on your computer.
+2. Run `cd /path/to/your/directory` to change the current working directory to the location where you want the cloned directory.
+3. Type `git clone`, and then paste the URL you copied earlier.
+
+    ```shell
+    git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
+    ```
+
+4. Press **Enter** to create your local clone.
+
+    ```text
+    $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
+    Cloning into 'Spoon-Knife'...
+    remote: Counting objects: 10, done.
+    remote: Compressing objects: 100% (8/8), done.
+    remote: Total 10 (delta 1), reused 10 (delta 1)
+    Unpacking objects: 100% (10/10), done.
+    ```
+
+## Next steps
+
+- [Create a repository from a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
+- [Manage user access to your organization's repositories](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories)
+- [Add a security policy to your repository](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository)

templates/quickstart/quickstart-template.md

@@ -0,0 +1,191 @@
+# Quickstart template <!-- This is an informative header; remove it before merging your content. -->
+
+| #  | Element                      | Format                  | Required |
+|:---|:-----------------------------|:------------------------|:--------:|
+| 1  | Title                        | H1                      | Yes      |
+| 2  | Subtitle                     | H4                      | Yes      |
+| 3  | Admonition                   | Information admonition  | Yes      |
+| 4  | "Overview" heading           | H2                      | Yes      |
+| 5  | "Overview" content           | Paragraph               | Yes      |
+| 6  | "Before you start" heading   | H2                      | No       |
+| 7  | "Before you start" content   | Bullet list             | No       |
+| 8  | Task 1 heading               | H2                      | Yes      |
+| 9  | Task 1 steps                 | Numbered list           | Yes      |
+| 10 | Task 1 code/image            | Code block or image     | No       |
+| 11 | Task 1 subtask heading       | H3                      | No       |
+| 12 | Task 1 subtask steps         | Numbered list           | No       |
+| 13 | Task 2 heading               | H2                      | No       |
+| 14 | Task 2 steps                 | Numbered list           | No       |
+| 15 | "Next steps" heading         | H2                      | No       |
+| 16 | "Next steps" content         | Paragraph or list       | No       |
+
+---
+title: ''
+topic: ''
+author: ''
+version: ''
+url: ''
+---
+
+# Quickstart
+
+#### { Subtitle }
+
+<!--
+Guidelines:
+
+- Single sentence with no links, list items, or formatting. Ends with a period.
+- Use H4 format. Stay under 120 characters / 20 words.
+- Use imperative verbs to describe the topic's purpose or benefit: *Explore*, *Get started*, *Try*, and so on.
+- Adds new value beyond the title. It should not repeat the title or be a rephrased version of it.
+
+> ⚙️ **Example:**
+> 
+> - *Get hands-on with Waku’s key capabilities.*
+> - *Quickly add payments to your project with Stripe.*
+-->
+
+(Optional) { Admonition }
+
+<!--
+This information-type admonition is exclusively to alert readers about who can use this feature and shouldn't be used for any other information. For example, a feature is only available to specific application role or using a specific tool or interface.
+
+> ⚙️ **Example:**
+>
+> *This feature is available to users with the **Admin** role in the application.*
+
+> ℹ️ **Note:**
+>
+> For more information, check out [Admonitions](../../docs-standards/20-style-the-content/12-admonitions.md)
+-->
+
+## Overview
+
+<!--
+Guidelines:
+
+- Use the "Overview" H2 heading for this section.
+- Start with what the user can accomplish in this quickstart. Then add a brief discussion of this product or feature and its core purposes.
+- The overview should be one or a maximum of two paragraphs. Use an additional [concept](./concept-help-me-to-understand.md) article if you need to provide more information.
+- Link to related topics to support the reader's gathering of information.
+-->
+
+## Before you start
+
+<!--
+This section provides:
+
+- The intended audience for this document. If you include this information in the [admonition](#admonition-optional) under the subtitle, you can still repeat it here to make sure readers are aware of the document's relevance.
+- The basic knowledge that you expect users to have before using this quickstart.
+- The software or hardware requirements for the quickstart.
+
+Guidelines:
+
+- Use the "Before you start" H2 heading for this section.
+- Write a single bullet list of noun phrases. Don't include verbs such as "learn" or "prepare".
+- Provide [links](../../20-style-the-content/10-links.md) to related content such as installation instructions or articles that provide required knowledge.
+- Setting up or installing prerequisites is not part of a quickstart. If you must explain the procedure and it takes less than three steps, include it in the [task](#task-section) where you describe setting up your product.
+
+> ⚙️ **Example:**
+> 
+> - Learn the basics of [Ethereum](https://ethereum.org/en/developers/docs/intro-to-ethereum/) ↗. 
+> - Learn how to use the command line.
+> - Prepare a machine running Ubuntu Linux with the following requirements:
+>   - 4 GB memory
+>   - 2 TB SSD
+>   - Linux 64-bit
+-->
+
+{ Task section }
+
+<!--
+Guidelines:
+
+- Choose two or three tasks that are essential, quick to complete, and provide immediate value to the user.
+    - The first task is usually about setting up or installing the product or feature. However, if setup is complex, create a separate installation guide and direct readers to it in the [Before you start](#before-you-start-section) section.
+    - For the other task(s), focus on the core functionalities of the product or feature.
+- If your quickstart involves a complex task, break it down into different logical subtasks with each subtask consisting of one or more related steps. 
+- Describe the most straightforward steps of the tasks.
+-->
+
+## { Task 1 heading }
+
+<!--
+Guidelines:
+
+- Don’t include “Task,” “Subtask,” or numbering in the heading.
+- Focus on the result, not on the task.
+- Start the title with an action verb in the imperative form. Don't use the -ing form of the verb.
+- Use H2 headings for each task.
+- Use H3 headings for each subtask.
+- Avoid H4 headings. Deeper levels (H5, H6) are forbidden. If you need more levels, reorganize the content into more tasks or subtasks.
+
+> ⚙️ **Example:**
+>
+> - *Run a Waku node*
+> - *Connect to the Codex network*
+> - *Configure system admin access*
+-->
+
+{ Task 1 steps }
+
+<!--
+Guidelines:
+
+- Optionally, include an introduction paragraph to provide context or required knowledge for the task.
+- Include a short description for each step, even when it contains a code sample.
+- Provide examples of sample output, such as return data, a message, so that the users can validate whether they perform the step correctly or not.
+- Include one action in a step.
+- Limit the procedure to a maximum of seven steps. If you need more steps to explain the task, create a subtask.
+
+> ⚙️ **Example:**
+>
+> ## Manage files using Codex Vault
+>
+> You can use Codex Vault, a GUI web application, to manage your files on the Codex testnet. Once you have your Codex node running using the installer, you can access the Codex Vault at https://app.codex.storage.
+>
+> ### Upload files
+>
+> 1. Open Codex Vault in your browser.
+> 1. In the Upload section, drag and drop your file or click **Upload** to choose it.
+> 1. Back up the file CID for download.
+>
+> ### Download files
+> 1. Open Codex Vault in your browser.
+> 1. In the Download section, enter the CID of the file you want to download.
+> 1. Click **Download**.
+-->
+
+(optional) { Code sample or image }
+
+<!--
+Use less than two images or code samples per step. If you need more, the step needs splitting. Make sure your code samples and images are up-to-date, functional, and relevant to the task. For more tips, check out [code](../../20-style-the-content/13-code.md) and [images](../../30-work-with-media/02-images.md) guidelines.
+
+> ℹ️ **Note:**
+>
+> When you use a code sample or image, it should be indented under the step description so that it's visually grouped with that step.
+-->
+
+(optional) ### { Task 1 subtask heading }
+
+(optional) { Task 1 subtask steps }
+
+## { Task 2 heading }
+
+{ Task 2 steps }
+
+...
+
+(optional) ## { Task n title }
+
+(optional) { Task n steps }
+
+(optional) ## Next steps
+
+<!--
+Guidelines:
+
+- Use the "Next steps" H2 heading for this section.
+- Use a bullet list to provide at most three links to articles about other tasks that the users can try after completing the quickstart. 
+- Consider a logical connection from the current quickstart that can act as a basis for your users' next learning.
+-->