50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
|
# Tutorial
|
||
|
|
|
||
|
|
Tutorials are learning-oriented articles that help users to go through a process and achieve a deliverable.
|
||
|
|
Start with an introduction: for whom is this tutorial and what the reader will achieve by reading it.
|
||
|
|
Answer the question: "Why should I follow this?"
|
||
|
|
|
||
|
|
Provide a short outline for the tutorial.
|
||
|
|
In this tutorial, you will learn how to:
|
||
|
|
* Do this
|
||
|
|
* Deal with that
|
||
|
|
|
||
|
|
## Before you start
|
||
|
|
|
||
|
|
List the prerequisites that are required or recommended.
|
||
|
|
|
||
|
|
Make sure that:
|
||
|
|
- First prerequisite
|
||
|
|
- Second prerequisite
|
||
|
|
|
||
|
|
## Part 1
|
||
|
|
|
||
|
|
Describe what the user will learn and accomplish in the first part,
|
||
|
|
then write a step-by-step procedure but on a real-world example.
|
||
|
|
|
||
|
|
1. Execute the following command in the terminal:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
run this --that
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Step with a [link](https://www.jetbrains.com)
|
||
|
|
|
||
|
|
3. Final step in part 1.
|
||
|
|
|
||
|
|
## Part 2
|
||
|
|
|
||
|
|
This is the second part of the tutorial:
|
||
|
|
|
||
|
|
1. Step 1
|
||
|
|
2. Step 2
|
||
|
|
3. Step n
|
||
|
|
|
||
|
|
## What you've learned {id="what-learned"}
|
||
|
|
|
||
|
|
Summarize what the reader achieved by completing this tutorial.
|
||
|
|
|
||
|
|
<seealso>
|
||
|
|
<!--Give some related links to how-to articles-->
|
||
|
|
</seealso>
|