Skip to content

Commit 94f5f7d

Browse files
committed
Merge branch 'main' into ngf-release-2.0
2 parents 387f02d + 142e4ec commit 94f5f7d

File tree

3 files changed

+5
-40
lines changed

3 files changed

+5
-40
lines changed

archetypes/concept.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,11 @@ This guide provides an overview of <concept>, which is used <for/in> <action 1>,
2222

2323
It is an example of a <other concept>, and is closely related to <third concept>.
2424

25-
---
26-
2725
## Background
2826

2927
[//]: # "Explain what the concept is. If possible, relate it to another commonly known concept or software."
3028
[//]: # "This relates the new idea to the reader using their existing knowledge, helping their understanding of it and thus what its purpose is in context."
3129

32-
---
33-
3430
## Use cases
3531

3632
[//]: # "Name the individual use case sections after the actual use case itself, e.g 'Route traffic between applications'"
@@ -56,7 +52,6 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
5652

5753
### Use case 2
5854

59-
---
6055

6156
## Conclusion
6257

@@ -65,8 +60,6 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
6560
[//]: # "Since each use case provides links to additional documents, you may not need to link to more,"
6661
[//]: # "or even include the final 'See also' section."
6762

68-
---
69-
7063
## See also
7164

72-
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
65+
[//]: # "Link to related documents, such as reference material or task instructions."

archetypes/default.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ nd-product:
2020

2121
This guide explains how to <X> with <Y>. In involves the use of <A>, <B> and <C>, demonstrating how <X> works with an example <Z>.
2222

23-
---
24-
2523
## Before you begin
2624

2725
[//]: # "List everything someone will need installed or configured before it's required. Link directly to installation guides where possible."
@@ -34,8 +32,6 @@ To complete this guide, you will need the following prerequisites:
3432

3533
[//]: # "Note the style of link for requirement two: keep the markdown extension. Links are resolved from the root of the documentation folder, often /site."
3634

37-
---
38-
3935
## Step 1
4036

4137
[//]: # "Explain the initial step: this is usually creating or configuring a resource. Sub-steps may not be necessary, depending on complexity."
@@ -51,38 +47,29 @@ To complete this guide, you will need the following prerequisites:
5147

5248
[//]: # "Sub-steps are ways of breaking steps into even smaller sections. Each step or sub-step should focus on one thing at a time: a user should be able to stop at the end of section and come back afterwards without leaving their software in a non-functional state."
5349

54-
---
55-
5650
### Sub-step 2
5751

5852
[//]: # "A useful final sub-step for a given section is some kind of verification or testing, so the reader is confident the steps have been successful."
5953

60-
---
61-
6254
## Step 2
6355

6456
[//]: # "Explain any additional steps required. If the how-to guide involves multiple components, each component can have its own step for delineation."
6557

6658
### Sub-step 1
6759

68-
---
6960

7061
### Sub-step 2
7162

72-
---
7363

7464
## Step 3
7565

7666
[//]: # "The final step of a how-to guide is usually a final test, and summarizes all of the previous steps taken to accomplish the purpose of the guide."
7767

7868
### Sub-step 1
7969

80-
---
8170

8271
### Sub-step 2
8372

84-
---
85-
86-
## See also
73+
## Next steps
8774

88-
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
75+
[//]: # "Link to the most common use cases after this specific instruction. For example. configuration usually follows installation."

archetypes/tutorial.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ By the end of the tutorial, you should have enough working knowledge of <thing>
2929

3030
<thing> is a common use for <product>: it enables the ability to use <feature 1>, <feature 2> and <feature 3>, which are important when configuring <product> for <use case>.
3131

32-
---
33-
3432
## Before you begin
3533

3634
[//]: # "List everything someone will need installed or configured before it's required. Link directly to installation guides where possible."
@@ -43,8 +41,6 @@ To complete this guide, you will need the following prerequisites:
4341

4442
[//]: # "Note the style of link for requirement two: keep the markdown extension. Links are resolved from the root of the documentation folder, often /site."
4543

46-
---
47-
4844
## Step 1
4945

5046
[//]: # "The text immediately following a heading in a tutorial should likely explain a concept to build a mental model of what the reader is about to do."
@@ -61,8 +57,6 @@ The first thing required for setting up <thing> is <step name>. This is the <ser
6157

6258
Starting from the <top/left> of the diagram, you can see that <thing> is connected to <other thing>: this relationship is established when configuring <parameter> as part of <file name>.
6359

64-
---
65-
6660
### Sub-step 1
6761

6862
[//]: # "The sub-steps of a tutorial should show the exact steps a reader should take to accomplish an action, and what to expect when doing so."
@@ -87,34 +81,25 @@ To verify the creation of <component>, you can also inspect information about it
8781
<the output of that command, possibly truncated and with changed IPs or domains>
8882
```
8983

90-
---
91-
9284
### Sub-step 2
9385

94-
---
95-
9686
## Step 2
9787

9888
[//]: # "Explain any additional steps required. If the tutorial involves multiple components, each component can have its own step for delineation."
9989

100-
---
101-
10290
### Sub-step 1
10391

104-
---
10592

10693
### Sub-step 2
10794

108-
---
10995

11096
## Conclusion
11197

11298
[//]: # "Summarize everything that the reader will have learned and accomplished by the end of this tutorial."
11399
[//]: # "It should fulfill the promise made by the introductory paragraph at the top of the document."
114100
[//]: # "You may wish to link to another tutorial as the next logical step, but that could also be part of the 'See also' section."
115101

116-
---
117102

118-
## See also
103+
## Next steps
119104

120-
[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
105+
[//]: # "Link to related documents, such as concepts, reference material or specific use cases."

0 commit comments

Comments
 (0)