master
mdx 54 lines 1.25 KB
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 author: "Your Name"
6 author_title: "Your title at Netdata"
7 author_img: "/img/authors/YourFace.jpg"
8 keywords: [keywords, describing, the main topics]
9 -->
10
11 A paragraph that explains what the tutorial does, why it matters, and the expected outcome.
12
13 To achieve goal:
14
15 1. [Do the first task](#first-task)
16 2. [Do the second task](#second-task)
17
18 ## Prerequisites
19
20 <!-- 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 :) -->
21
22 Optional. List all needed prerequisites:
23
24 - Prerequisite 1
25 - Prerequisite 2
26 - Prerequisite 3
27
28 ## First task
29
30 To do x:
31
32 1. Step 1 written in active voice
33 ```bash
34 Code sample for step
35 ```
36 2. Step 2
37 Result of step 2, for example a system reaction; written in passive voice
38 3. Step 3
39
40 ## Second task
41
42 To do x:
43
44 1. Step 1 written in active voice
45 ```bash
46 Code sample for step
47 ```
48 2. Step 2
49 Result of step 2, for example a system reaction; written in passive voice
50 3. Step 3
51
52 ## What's next?
53
54 Optional section that explains the next logical steps.