-
Notifications
You must be signed in to change notification settings - Fork 88
/
conceptual_tutorial_template.md.txt
142 lines (79 loc) · 3.86 KB
/
conceptual_tutorial_template.md.txt
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<!--
This is an article template you can use as a quick starting point when writing DigitalOcean conceptual tutorials.
Once you've reviewed the template, delete the comments and begin writing your outline or article. You'll find some examples of our custom Markdown at the very bottom of the template.
As you write, refer to our style and formatting guidelines for more detailed explanations:
- [do.co/style](https://do.co/style)
Use our [Markdown previewer](https://www.digitalocean.com/community/markdown) to review your article's formatting.
-->
# Understanding [Some Concept]
<!-- Use Title Case for all Titles -->
<!-- Learn about the title, introduction, and Goals sections at https://do.co/style#title-introduction-and-goals -->
<!-- Learn about formatting headers at https://do.co/style#headers -->
### Introduction
<!-- Our articles have a specific structure. Learn more at https://do.co/style/structure -->
Introductory paragraph about the topic that explains what this topic is about and why the reader should care; what problem does it solve?
In this guide, you will [explore] [some thing]...
When you're finished, you'll be able to...
## Prerequisites
<!-- Prerequisites let you leverage existing tutorials so you don't have to repeat installation or setup steps in your tutorial. Learn more at https://do.co/style#prerequisites -->
##
<!-- For more information on steps, see https://do.co/style/#steps -->
Introduction to the step. What are we going to do and why are we doing it?
First....
Next...
Finally...
Now transition to the next section by telling the reader what's next.
## Another Section
Another introduction
Your content
Transition to the next section
## Conclusion
In this article you [explored/learned] [something]. Now you can....
<!-- Speak to reader benefits of this technique or procedure and optionally provide places for further exploration. -->
<!------------ Formatting ------------------------->
<!-- Some examples of how to mark up various things
This is _italics_ and this is **bold**.
Only use italics and bold for specific things. Learn more at https://do.co/style#bold-and-italics
This is `inline code`. Use it for referencing package names and commands.
Here's a command someone types in the Terminal:
```command
sudo nano /etc/nginx/sites-available/default
```
Here's a configuration file. The label on the first line lets you clearly state the file that's being shown or modified:
```nginx
[label /etc/nginx/sites-available/default]
server {
listen 80 default_server;
listen [::]:80 default_server ipv6only=on;
root <^>/usr/share/nginx/html<^>;
index index.html index.htm;
server_name localhost;
location / {
try_files $uri $uri/ =404;
}
}
```
Here's output from a command:
```
[secondary_label Output]
Could not connect to Redis at 127.0.0.1:6379: Connection refused
```
Learn about formatting commands and terminal output at https://do.co/style#code
Key presses should be written in ALLCAPS with in-line code formatting: `ENTER`.
Use a plus symbol (+) if keys need to be pressed simultaneously: `CTRL+C`.
This is a <^>variable<^>.
This is an `<^>in-line code variable<^>`
Learn more about how to use variables to highlight important items at https://do.co/style#variables
Use `<^>your_server_ip<^>` when referencing the IP of the server. Use `111.111.111.111` and `222.222.222.222` if you need other IP addresses in examples.
Learn more about host names and domains at https://do.co/style#users-hostnames-and-domains
<$>[note]
**Note:** This is a note.
<$>
<$>[warning]
**Warning:** This is a warning.
<$>
Learn more about notes at https://do.co/style#notes-and-warnings
Screenshots should be in PNG format and hosted on imgur. Embed them in the article using the following format:
![Alt text for screen readers](/path/to/img.png)
Learn more about images at https://do.co/style#images-and-other-assets
-->