master
md 41 lines 1.07 KB
Rendered Raw
1 <!--
2 title: Starts with an active verb, like "Create a widget" or "Delete a widget"
3 description: Short summary (will be displayed in search engines)
4 custom_edit_url: Edit URL of the source file
5 keywords: [keywords, describing, the main topics]
6 -->
7 # Title
8
9 Short description of why or when the procedure makes sense.
10
11 ## Subheading that describes the task
12 #### Prerequisites
13 <!-- If there is only one requirement, use a paragraph instead of a single bullet item. Bullets are social animals and only appear in groups of 2 or more :) -->
14 Optional. List all needed prerequisites:
15 - Prerequisite 1
16 - Prerequisite 2
17 - Prerequisite 3
18
19 To do x:
20
21 1. Step 1 written in active voice
22 ```bash
23 Code sample for step
24 ```
25 2. Step 2
26 Result of step 2, for example a system reaction; written in passive voice
27 3. Step 3
28
29 ## If needed, another task section
30
31 See lines 11-24
32
33 <!-- Optional -->
34 ## What's next?
35
36 Optional section that explains the next logical steps.
37
38 <!-- Optional -->
39 ## Related links
40
41 - Visit the [related thing documentation](www.related-thing.com) to learn more about related thing.