You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: contributing/content-templates.md
+29-29
Original file line number
Diff line number
Diff line change
@@ -27,17 +27,17 @@ versions:
27
27
<!-- For product version instructions, see https://github.com/github/docs/tree/main/content#versions.-->
28
28
<!-- Remove these comments from your article file when you're done writing. -->
29
29
30
-
### A section here
30
+
## A section here
31
31
32
32
<!-- Write one or two paragraphs about the main idea of your topic, as a summary. -->
33
33
<!-- Make sure you don't have any content that isn't preceded by a header, or it won't be linkable in our TOC. -->
34
34
35
-
### Another section here
35
+
## Another section here
36
36
37
37
<!-- Write one or two paragraphs about another element of your topic. -->
38
38
<!-- Keep adding headers and sections until you've completed your article. -->
39
39
40
-
### Further reading
40
+
## Further reading
41
41
42
42
<!-- Optionally, include a bulleted list of related articles the user can reference to extend the concepts covered in this article. Consider linking to procedural articles or tutorials that help the user use the information in your article. -->
43
43
@@ -62,17 +62,17 @@ versions:
62
62
<!-- For product version instructions, see https://github.com/github/docs/tree/main/content#versions.-->
63
63
<!-- Remove these comments from your article file when you're done writing -->
64
64
65
-
### A section here
65
+
## A section here
66
66
67
67
<!-- Write one or two paragraphs about the main idea of your topic, as a summary. -->
68
68
<!-- Make sure you don't have any content that isn't preceded by a header, or it won't be linkable in our TOC. -->
69
69
70
-
### Another section here
70
+
## Another section here
71
71
72
72
<!-- Write one or two paragraphs about another element of your topic. -->
73
73
<!-- Keep adding headers and sections until you've completed your article. -->
74
74
75
-
### Further reading
75
+
## Further reading
76
76
77
77
<!-- Optionally, include a bulleted list of related articles the user can reference to extend the concepts covered in this article. Consider linking to procedural articles or tutorials that help the user use the information in your article. -->
78
78
@@ -97,17 +97,17 @@ versions:
97
97
<!-- For product version instructions, see https://github.com/github/docs/tree/main/content#versions.-->
98
98
<!-- Remove these comments from your article file when you're done writing -->
99
99
100
-
### Procedural section header here
100
+
## Procedural section header here
101
101
102
102
<!-- Include prerequisite information or specific permissions information here. -->
103
103
<!-- Then write procedural steps following the instructions in https://github.com/github/docs/blob/main/contributing/content-model.md#procedural-steps. -->
104
104
<!-- Check if there's already a reusable string for the step you want to write in https://github.com/github/docs/tree/main/data/reusables. Tip: Look at the source file for a procedure located in the same area of the user interface to find reusables. -->
105
105
106
-
### Optionally, another procedural section here
106
+
## Optionally, another procedural section here
107
107
108
108
<!-- Keep adding procedures until you've finished writing your article. -->
109
109
110
-
### Further reading
110
+
## Further reading
111
111
112
112
<!-- Optionally, include a bulleted list of related articles the user can reference to extend the concepts covered in this article. Consider linking to procedural articles or tutorials that help the user use the information in your article. -->
113
113
@@ -130,35 +130,35 @@ versions:
130
130
<!-- The entire quickstart should be about 600 words long or take about five minutes to read.-->
131
131
<!-- Remove these comments from your article file when you're done writing -->
132
132
133
-
### Introduction
133
+
## Introduction
134
134
135
135
<!-- Build on the quick phrasing above by:
136
136
- Clarifying the audience
137
137
- Clearly stating prerequisites and prior knowledge needed
138
138
- Stating what the user will accomplish or build-->
139
139
140
-
### Step one: Action the user will take
140
+
## Step one: Action the user will take
141
141
142
142
<!-- In one sentence, describe what the user will do in this step -->
143
143
<!-- Steps should break down the tasks the user will complete in sequential order -->
144
144
<!-- Avoid replicating conceptual information that is covered elsewhere, provide inline links instead. Only include conceptual information unique to this use case. -->
145
145
146
-
#### Task chunk
146
+
### Task chunk
147
147
148
148
<!-- A step may require the user to perform several tasks - break those tasks down into chunks, allowing the user to scan quickly to find their place if they navigated away from this screen to perform the task. -->
149
149
<!-- An example might be creating a PAT for the action to use and then storing it in secrets -->
150
150
<!-- For UI based tasks, include the button or options the users should click -->
151
151
<!-- If the task adds code, include the code in context (don't just show `needs: setup` show the entire `setup` and `dependent` jobs) -->
152
152
153
-
#### Another task chunk
153
+
### Another task chunk
154
154
155
155
<!-- remove all of these comments when you're done -->
156
156
157
-
### Step 2: Do the next thing
157
+
## Step 2: Do the next thing
158
158
159
159
<!-- Rinse and repeat, adding steps and tasks until the tutorial is complete -->
160
160
161
-
### Next steps
161
+
## Next steps
162
162
163
163
<!-- Provide a quick recap of what has been accomplished in the quick start as a means of transitioning to next steps. Include 2-3 actionable next steps that the user take after completing the quickstart. Always link to conceptual content on the feature or product. You can also link off to other related information on docs.github.com or in GitHub Learning Labs. -->
164
164
```
@@ -181,7 +181,7 @@ versions:
181
181
<!-- For product version instructions, see https://github.com/github/docs/tree/main/content#versions.-->
182
182
<!-- Remove these comments from your article file when you're done writing -->
183
183
184
-
### Introduction
184
+
## Introduction
185
185
186
186
<!-- The tutorial introduction should include the following in a short paragraph:
187
187
@@ -190,24 +190,24 @@ versions:
190
190
- State what the user will accomplish or build and the user problem it solves
191
191
- Link to an example of the project the user will complete -->
192
192
193
-
### Step 1: Action the user will take
193
+
## Step 1: Action the user will take
194
194
195
195
<!-- In one sentence, describe what the user will do in this step -->
196
196
<!-- Steps should break down the tasks the user will complete in sequential order -->
197
197
<!-- Avoid replicating conceptual information that is covered elsewhere, provide inline links instead. Only include conceptual information unique to this use case. -->
198
198
199
-
#### Task chunk
199
+
### Task chunk
200
200
201
201
<!-- A step may require the user to perform several tasks - break those tasks down into chunks, allowing the user to scan quickly to find their place if they navigated away from this screen to perform the task. -->
202
202
<!-- An example might be creating a PAT for the action to use and then storing it in secrets -->
203
203
<!-- For UI based tasks, include the button or options the users should click -->
204
204
<!-- If the task adds code, include the code in context (don't just show `needs: setup` show the entire `setup` and `dependent` jobs) -->
205
205
206
-
#### Another task chunk
206
+
### Another task chunk
207
207
208
208
<!-- remove all of these comments when you're done -->
209
209
210
-
### Step 2: Do the next thing
210
+
## Step 2: Do the next thing
211
211
212
212
<!-- Rinse and repeat, adding steps and tasks until the tutorial is complete
213
213
@@ -219,7 +219,7 @@ on:
219
219
- cron: "40 19 * * *"
220
220
``` -->
221
221
222
-
### Further reading
222
+
## Further reading
223
223
224
224
<!-- include a bulleted list of tutorials or articles the user can reference to extend the concepts taught in this tutorial -->
225
225
@@ -244,7 +244,7 @@ versions:
244
244
- Remove these comments from your article file when you're done writing
245
245
-->
246
246
247
-
### Introduction
247
+
## Introduction
248
248
249
249
<!--
250
250
The language guide introduction should include the following in a short paragraph:
@@ -254,7 +254,7 @@ versions:
254
254
- State what the user will accomplish or build and the user problem it solves.
255
255
-->
256
256
257
-
### Starting with the <language> workflow template
257
+
## Starting with the <language> workflow template
258
258
259
259
<!--
260
260
Language guides typically walk through and build upon a starter workflow template. If that format doesn't work, you can include a boilerplate workflow.
@@ -263,13 +263,13 @@ versions:
263
263
- Include the starter template workflow code.
264
264
-->
265
265
266
-
### Running on different operating systems
266
+
## Running on different operating systems
267
267
268
268
<!--
269
269
Include a brief overview of how to choose the runner environment. These should be alternatives to what operating system is presented in the starter workflow/boilerplate template.
270
270
-->
271
271
272
-
### Configuring the <language> version
272
+
## Configuring the <language> version
273
273
<!--
274
274
- Describe when and how to use available setup actions that configure the version of the language on the runner (ex. actions/setup-node).
275
275
- How does the setup action configure the version and what happens when the version isn't supported in the environment. What is the default version, when no version is configured.
@@ -281,7 +281,7 @@ versions:
281
281
- Include code samples.
282
282
-->
283
283
284
-
### Installing dependencies
284
+
## Installing dependencies
285
285
286
286
<!--
287
287
- Include example of installing dependencies to prepare for building and testing.
@@ -291,13 +291,13 @@ versions:
291
291
- Include code samples.
292
292
-->
293
293
294
-
### Caching dependencies
294
+
## Caching dependencies
295
295
296
296
<!--
297
297
Include an example of restoring cached dependencies. We'll want to link out to the article about caching for more information (https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows).
298
298
-->
299
299
300
-
### Building your code
300
+
## Building your code
301
301
302
302
<!--
303
303
- Include any compile steps.
@@ -307,7 +307,7 @@ versions:
307
307
- Include any common databases or services that might be needed. If so, we can link out to the services guides in the docs (https://docs.github.com/en/actions/configuring-and-managing-workflows/using-databases-and-service-containers).
308
308
-->
309
309
310
-
### Packaging workflow data as artifacts
310
+
## Packaging workflow data as artifacts
311
311
312
312
<!--
313
313
This section can simply link out to https://docs.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts or provide additional information about which artifacts might be typical to upload for a CI workflow.
0 commit comments