diff --git a/docs-standards/10-structure-the-content/01-document-types/quickstart-help-me-get-started.md b/docs-standards/10-structure-the-content/01-document-types/quickstart-help-me-get-started.md index 2867657..54dfe28 100644 --- a/docs-standards/10-structure-the-content/01-document-types/quickstart-help-me-get-started.md +++ b/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. diff --git a/examples/quickstart-example.md b/examples/quickstart-example.md new file mode 100644 index 0000000..2ddb1cf --- /dev/null +++ b/examples/quickstart-example.md @@ -0,0 +1,99 @@ +--- +title: Quickstart +topic: Repositories +author: jorge-campo, cheny0 +version: 1 +url: docs/repositories/quickstart +--- + + + +# 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) diff --git a/examples/quickstart-example/copy-icon.png b/examples/quickstart-example/copy-icon.png new file mode 100644 index 0000000..5c3b188 Binary files /dev/null and b/examples/quickstart-example/copy-icon.png differ diff --git a/examples/quickstart-example/create-a-repository-step-1.png b/examples/quickstart-example/create-a-repository-step-1.png new file mode 100644 index 0000000..dc9db21 Binary files /dev/null and b/examples/quickstart-example/create-a-repository-step-1.png differ diff --git a/examples/quickstart-example/edit-icon.png b/examples/quickstart-example/edit-icon.png new file mode 100644 index 0000000..627d0b8 Binary files /dev/null and b/examples/quickstart-example/edit-icon.png differ diff --git a/examples/quickstart-example/edit-the-readme-step-3.png b/examples/quickstart-example/edit-the-readme-step-3.png new file mode 100644 index 0000000..07dd1b6 Binary files /dev/null and b/examples/quickstart-example/edit-the-readme-step-3.png differ diff --git a/templates/quickstart/quickstart-template.md b/templates/quickstart/quickstart-template.md new file mode 100644 index 0000000..bf72b41 --- /dev/null +++ b/templates/quickstart/quickstart-template.md @@ -0,0 +1,191 @@ +# Quickstart template + +| # | 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 } + + + +(Optional) { Admonition } + + + +## Overview + + + +## Before you start + + + +{ Task section } + + + +## { Task 1 heading } + + + +{ Task 1 steps } + + + +(optional) { Code sample or image } + + + +(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 + + diff --git a/templates/quickstart/template-quickstart.md b/templates/quickstart/template-quickstart.md deleted file mode 100644 index e69de29..0000000