Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Reviewing comments - part1
Browse files Browse the repository at this point in the history
  • Loading branch information
gayathri-krishnaswamy committed Jan 13, 2022
1 parent 26cc771 commit 1bb5402
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 139 deletions.
107 changes: 0 additions & 107 deletions quickstarts/about-quickstarts.md

This file was deleted.

60 changes: 28 additions & 32 deletions quickstarts/template-quickstarts.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,57 @@
# Title

{Before using this template, read the accompanying [quickstart template guide](about-quickstarts.md).}
:information_source: Before using this template, read the accompanying [quickstart template guide](about-quickstarts.md).

**Document Version:**{MAJOR.MINOR.PATCH}
**Document Version:** {MAJOR.MINOR.PATCH}

**Last Updated:** {"Month DD, _YYYY" or "Month YYYY"}
**Last Updated:** {"Month DD, YYYY" or "Month YYYY"}

**Application Version:**

* {Application 1}: {MAJOR.MINOR.PATCH}
* {Application 2}: {MAJOR.MINOR.PATCH} or later
* ...
- {Application 1}: {MAJOR.MINOR.PATCH}
- {Application 2}: {MAJOR.MINOR.PATCH} or later
- ...

## Overview

This quickstart guides you through:
* [Part 1](#part-1-description)
* [Part 2](#part-2-description)
* [Part n](#part-n-description)
- [Part 1](#part-1-description)
- [Part 2](#part-2-description)
- [Part n](#part-n-description)

{(Optional) Link each part to its corresponding section for easy access}
:information_source: (Optional) Link each part to its corresponding section for easy access

It is intended for {audience}. It assumes that you have basic knowledge of:
* Concept 1
* Concept 2
* Concept 3
- Concept 1
- Concept 2
- Concept 3

{Link each concept to its corresponding content that help users understand the concepts and ideas behind your software. }
:information_source: Link each concept to its corresponding content that help users understand the concepts and ideas behind your software.

## Before You Begin
## Before you begin

Complete all prerequisites before proceeding with the rest of the quickstart

* Prerequisite 1
* Prerequisite 2
* Prerequisite 3
- Prerequisite 1
- Prerequisite 2
- Prerequisite 3

## Installation
## Installation

{Use this section to provide installation instructions.}
:information_source: (Optional) Use this section to provide installation instructions.

## Part 1 - {Description}

{Use this section to summarize what users will complete in the following steps.}
:information_source: Use this section to summarize what users will complete in the following steps.

### Step 1 - {Task name}

{Include any code samples, snippets, or screenshots that will help your user complete the task.If users should see a result after
completing this step, make sure to include it.}
:information_source: Include any code samples, snippets, or screenshots that will help your user complete the task.If users should see a result after
completing this step, make sure to include it.

#### (Optional) Sub step 1 - {Subtask name}

{Beware of asking your users to do too much in one step. If needed, break a step into one or two smaller substeps.}
:information_source: Beware of asking your users to do too much in one step. If needed, break a step into one or two smaller substeps.

## Part 2 - {Description}

Expand All @@ -65,7 +65,6 @@ completing this step, make sure to include it.}

...


## Part n - {Description}

...
Expand All @@ -78,12 +77,9 @@ completing this step, make sure to include it.}

...



## Next Steps
## Next steps

Now that you've completed this quickstart, try these to learn more about {feature}.
* Reference Link 1
* Reference Link 2
* Reference Link n

- Reference Link 1
- Reference Link 2
- Reference Link n

0 comments on commit 1bb5402

Please sign in to comment.