-
Notifications
You must be signed in to change notification settings - Fork 88
/
software_development_tutorial_template.md.txt
261 lines (166 loc) · 8.84 KB
/
software_development_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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!--
This is an article template you can use as a starting point when writing DigitalOcean procedural tutorials about software development. This template is great for Python, JavaScript, or other softwar development tutorials that readers would follow. 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.
Readers should be able to follow your tutorial from the beginning to the end on their own computer. Before submitting your article to the editorial team, please be sure to test your article from start to finish on it exactly as written. Cut and paste commands from the article into your terminal to make sure there aren't typos in the commands. If you find yourself executing a command that isn't in the article, incorporate it into the article to make sure the reader gets the exact same results. We will test your article and send it back to you if we run into technical problems, which significantly slows down the publication process.
-->
# How To [Build/Create/Do Something] in [JavaScript/Node.js/Python 3/Go]
<!-- 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 -->
<!-- Our articles have a specific structure. Procedural tutorials follow this structure:
* Title
* Introduction (Level 3 heading)
* Prerequisites (Level 2 heading)
* Step 1 — Doing Something (Level 2 heading)
* Step 2 — Doing Something (Level 2 heading)
...
* Step 5 — Doing Something (Level 2 heading)
* Conclusion (Level 2 heading)
Learn more at https://do.co/style/structure -->
### Introduction
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 [configure/set up/build/] [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 -->
To complete this tutorial, you will need:
* A local development environment for [your language]
* Familiarity with [the language]. You can look at the [tutorial series for the language] to learn more.
* (Optional) If software such as Git, Docker, or other tooling needs to be installed, link to the proper article describing how to install it.
* (Optional) List any other accounts needed, such as GitHub, Facebook, or other services.
<!-- Example - uncomment to use
* A local development environment for Node.js. Follow [How to Install Node.js and Create a Local Development Environment](https://www.digitalocean.com/community/tutorial_series/how-to-install-node-js-and-create-a-local-development-environment).
* A text editor like [Visual Studio Code](https://code.visualstudio.com/download) or [Atom](https://atom.io/).
* A web browser like [Firefox](https://www.mozilla.org/en-US/firefox/new/) or [Chrome](https://www.google.com/chrome/).
* Familiarity with JavaScript. You can look at the [How To Code in JavaScript](https://www.digitalocean.com/community/tutorial_series/how-to-code-in-javascript) series to learn more.
* Familiarity with React. You can take a look at our [How To Code in React.js](https://www.digitalocean.com/community/tutorial_series/how-to-code-in-react-js) series.
-->
## Step 1 — Doing Something
<!-- 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...
<!-- When showing a command, explain the command first by talking about what it does. Then show the command. Then show its output in a separate output block: -->
Run the following command to create your React app:
```command
npx create-react-app <^>digital-ocean-tutorial<^>
```
You'll see the following output:
```
[secondary_label Output]
...
Success! Created <^>digital-ocean-tutorial at <^>your_file_path/digital-ocean-tutorial<^>
Inside that directory, you can run several commands:
npm start
Starts the development server.
npm run build
Bundles the app into static files for production.
npm test
Starts the test runner.
npm run eject
Removes this tool and copies build dependencies, configuration files
and scripts into the app directory. If you do this, you can’t go back!
We suggest that you begin by typing:
cd <^>digital-ocean-tutorial<^>
npm start
Happy hacking!
```
<!-- You can use highlighting in output to point out relevant details -->
<!-- When asking the reader to open a file, be sure to specify the file name:
Open the file `public/index.htm` in your editor.
<!-- When showing the contents of a file, try to show only the relevant parts and explain what needs to change. -->
Modify the title by changning the contents of the `<title>` tag:
```js
[label public/index.html]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
...
<title><^>Sandbox<^></title>
</head>
...
```
<!-- See do.co/style#commands-and-code-in-steps for more on how to incorporate command and code in your steps. -->
Now transition to the next step by telling the reader what's next.
## Step 2 — Title Case
Another introduction
Your content
Transition to the next step.
## Step 3 — Title Case
Another introduction
Your content
Transition to the next step.
## Conclusion
In this article you [configured/set up/built/deployed] [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
npm start
```
Here's output from a command:
```
[secondary_label Output]
Compiled successfully!
You can now view <^>digital-ocean-tutorial<^> in the browser.
http://localhost:3000
Note that the development build is not optimized.
To create a production build, use npm run build.
```
Learn about formatting commands and terminal output at https://do.co/style#code
Here's a file full of code. The label on the first line lets you clearly state the file that's being shown or modified. Highlighted lines show what the reader should change.
```js
[label digital-ocean-tutorial/public/index.html]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
...
<title><^>Sandbox<^></title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>
```
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
-->