template-how-to.md

How To template

Overview

Summarize what this How To article is about in a sentence or two. How To articles primarily include tasks, and answer the question "how do I do it?".

Keywords: Optional: add comma-separated keywords.

Before you start

Before you begin, make sure you meet these prerequisites:

• Pre-requisite one
• Pre-requisite two

Include other important information here, such as known issues or bugs.

Step-by-step guide

Step 1: Optional: Title for step - image or screenshot

Brief instructions explaining how to interpret the image.

Step 2: Optional: title for step - ordered list

Lead-in sentence for an ordered list:

1. Sub-step A
2. Sub-step B
3. Sub-step C

Step 3: Optional: title for step - code snippet

Lead-in sentence explaining the code snippet. For example:

Run the apt command to install the Asciidoctor package and check the version.

$ sudo apt install asciidoctor

$ asciidoctor --version
Asciidoctor 1.5.6.2 [https://asciidoctor.org]

Step 4: Optional: title for step - Conclusion

Provide a summary of the steps completed and explain what the user has achieved by following them. You can also include links to related articles that may help the reader reinforce concepts discussed in this How To article.

See also

Include references and/or links to other related documentation, either internal to the project or external. After a leading sentence on why/how they are valuable to readers of the current topic, multiple related can be displayed in a list:

• One list for a small number of items, which can contain internal and external references, or;
• Two lists, divided into internal and external and separated by another leading sentence, if there are a larger number of items.