Skip to content

Commit 5babd75

Browse files
authored
Update template headings from H3 ->H2 etc. (github#19924)
1 parent d9b343d commit 5babd75

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

contributing/content-templates.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ versions:
2727
<!-- For product version instructions, see https://github.com/github/docs/tree/main/content#versions.-->
2828
<!-- Remove these comments from your article file when you're done writing. -->
2929
30-
### A section here
30+
## A section here
3131
3232
<!-- Write one or two paragraphs about the main idea of your topic, as a summary. -->
3333
<!-- Make sure you don't have any content that isn't preceded by a header, or it won't be linkable in our TOC. -->
3434
35-
### Another section here
35+
## Another section here
3636
3737
<!-- Write one or two paragraphs about another element of your topic. -->
3838
<!-- Keep adding headers and sections until you've completed your article. -->
3939
40-
### Further reading
40+
## Further reading
4141
4242
<!-- 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. -->
4343
@@ -62,17 +62,17 @@ versions:
6262
<!-- For product version instructions, see https://github.com/github/docs/tree/main/content#versions.-->
6363
<!-- Remove these comments from your article file when you're done writing -->
6464
65-
### A section here
65+
## A section here
6666
6767
<!-- Write one or two paragraphs about the main idea of your topic, as a summary. -->
6868
<!-- Make sure you don't have any content that isn't preceded by a header, or it won't be linkable in our TOC. -->
6969
70-
### Another section here
70+
## Another section here
7171
7272
<!-- Write one or two paragraphs about another element of your topic. -->
7373
<!-- Keep adding headers and sections until you've completed your article. -->
7474
75-
### Further reading
75+
## Further reading
7676
7777
<!-- 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. -->
7878
@@ -97,17 +97,17 @@ versions:
9797
<!-- For product version instructions, see https://github.com/github/docs/tree/main/content#versions.-->
9898
<!-- Remove these comments from your article file when you're done writing -->
9999
100-
### Procedural section header here
100+
## Procedural section header here
101101
102102
<!-- Include prerequisite information or specific permissions information here. -->
103103
<!-- Then write procedural steps following the instructions in https://github.com/github/docs/blob/main/contributing/content-model.md#procedural-steps. -->
104104
<!-- 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. -->
105105
106-
### Optionally, another procedural section here
106+
## Optionally, another procedural section here
107107
108108
<!-- Keep adding procedures until you've finished writing your article. -->
109109
110-
### Further reading
110+
## Further reading
111111
112112
<!-- 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. -->
113113
@@ -130,35 +130,35 @@ versions:
130130
<!-- The entire quickstart should be about 600 words long or take about five minutes to read.-->
131131
<!-- Remove these comments from your article file when you're done writing -->
132132
133-
### Introduction
133+
## Introduction
134134
135135
<!-- Build on the quick phrasing above by:
136136
- Clarifying the audience
137137
- Clearly stating prerequisites and prior knowledge needed
138138
- Stating what the user will accomplish or build-->
139139
140-
### Step one: Action the user will take
140+
## Step one: Action the user will take
141141
142142
<!-- In one sentence, describe what the user will do in this step -->
143143
<!-- Steps should break down the tasks the user will complete in sequential order -->
144144
<!-- Avoid replicating conceptual information that is covered elsewhere, provide inline links instead. Only include conceptual information unique to this use case. -->
145145
146-
#### Task chunk
146+
### Task chunk
147147
148148
<!-- 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. -->
149149
<!-- An example might be creating a PAT for the action to use and then storing it in secrets -->
150150
<!-- For UI based tasks, include the button or options the users should click -->
151151
<!-- If the task adds code, include the code in context (don't just show `needs: setup` show the entire `setup` and `dependent` jobs) -->
152152
153-
#### Another task chunk
153+
### Another task chunk
154154
155155
<!-- remove all of these comments when you're done -->
156156
157-
### Step 2: Do the next thing
157+
## Step 2: Do the next thing
158158
159159
<!-- Rinse and repeat, adding steps and tasks until the tutorial is complete -->
160160
161-
### Next steps
161+
## Next steps
162162
163163
<!-- 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. -->
164164
```
@@ -181,7 +181,7 @@ versions:
181181
<!-- For product version instructions, see https://github.com/github/docs/tree/main/content#versions.-->
182182
<!-- Remove these comments from your article file when you're done writing -->
183183
184-
### Introduction
184+
## Introduction
185185
186186
<!-- The tutorial introduction should include the following in a short paragraph:
187187
@@ -190,24 +190,24 @@ versions:
190190
- State what the user will accomplish or build and the user problem it solves
191191
- Link to an example of the project the user will complete -->
192192
193-
### Step 1: Action the user will take
193+
## Step 1: Action the user will take
194194
195195
<!-- In one sentence, describe what the user will do in this step -->
196196
<!-- Steps should break down the tasks the user will complete in sequential order -->
197197
<!-- Avoid replicating conceptual information that is covered elsewhere, provide inline links instead. Only include conceptual information unique to this use case. -->
198198
199-
#### Task chunk
199+
### Task chunk
200200
201201
<!-- 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. -->
202202
<!-- An example might be creating a PAT for the action to use and then storing it in secrets -->
203203
<!-- For UI based tasks, include the button or options the users should click -->
204204
<!-- If the task adds code, include the code in context (don't just show `needs: setup` show the entire `setup` and `dependent` jobs) -->
205205
206-
#### Another task chunk
206+
### Another task chunk
207207
208208
<!-- remove all of these comments when you're done -->
209209
210-
### Step 2: Do the next thing
210+
## Step 2: Do the next thing
211211
212212
<!-- Rinse and repeat, adding steps and tasks until the tutorial is complete
213213
@@ -219,7 +219,7 @@ on:
219219
- cron: "40 19 * * *"
220220
``` -->
221221
222-
### Further reading
222+
## Further reading
223223
224224
<!-- include a bulleted list of tutorials or articles the user can reference to extend the concepts taught in this tutorial -->
225225
@@ -244,7 +244,7 @@ versions:
244244
- Remove these comments from your article file when you're done writing
245245
-->
246246
247-
### Introduction
247+
## Introduction
248248
249249
<!--
250250
The language guide introduction should include the following in a short paragraph:
@@ -254,7 +254,7 @@ versions:
254254
- State what the user will accomplish or build and the user problem it solves.
255255
-->
256256
257-
### Starting with the <language> workflow template
257+
## Starting with the <language> workflow template
258258
259259
<!--
260260
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:
263263
- Include the starter template workflow code.
264264
-->
265265
266-
### Running on different operating systems
266+
## Running on different operating systems
267267
268268
<!--
269269
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.
270270
-->
271271
272-
### Configuring the <language> version
272+
## Configuring the <language> version
273273
<!--
274274
- Describe when and how to use available setup actions that configure the version of the language on the runner (ex. actions/setup-node).
275275
- 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:
281281
- Include code samples.
282282
-->
283283
284-
### Installing dependencies
284+
## Installing dependencies
285285
286286
<!--
287287
- Include example of installing dependencies to prepare for building and testing.
@@ -291,13 +291,13 @@ versions:
291291
- Include code samples.
292292
-->
293293
294-
### Caching dependencies
294+
## Caching dependencies
295295
296296
<!--
297297
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).
298298
-->
299299
300-
### Building your code
300+
## Building your code
301301
302302
<!--
303303
- Include any compile steps.
@@ -307,7 +307,7 @@ versions:
307307
- 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).
308308
-->
309309
310-
### Packaging workflow data as artifacts
310+
## Packaging workflow data as artifacts
311311
312312
<!--
313313
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

Comments
 (0)