summaryrefslogtreecommitdiffstats
path: root/docs/.templates/.page-level/_tutorial-page-template.mdx
blob: 9f64b5ece86cd14e0461bafaecf951cf7b25d84d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<!--
title: Starts with an active verb, like "Create a widget" or "Delete a widget"
description: Short summary (will be displayed in search engines)
custom_edit_url: Edit URL of the source file
author: "Your Name"
author_title: "Your title at Netdata"
author_img: "/img/authors/YourFace.jpg"
keywords: [keywords, describing, the main topics]
-->

A paragraph that explains what the tutorial does, why it matters, and the expected outcome.

To achieve goal:

1. [Do the first task](#first-task)
2. [Do the second task](#second-task)

## Prerequisites

<!-- 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 :) -->

Optional. List all needed prerequisites:

- Prerequisite 1
- Prerequisite 2
- Prerequisite 3

## First task

To do x:

1. Step 1 written in active voice
   ```bash
   Code sample for step
   ```
2. Step 2
   Result of step 2, for example a system reaction; written in passive voice
3. Step 3

## Second task

To do x:

1. Step 1 written in active voice
   ```bash
   Code sample for step
   ```
2. Step 2
   Result of step 2, for example a system reaction; written in passive voice
3. Step 3

## What's next?

Optional section that explains the next logical steps.