Skip to content

feat: Update Hugo archetypes to remove HRs and change final subsection #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions archetypes/concept.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,11 @@ This guide provides an overview of <concept>, which is used <for/in> <action 1>,

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

---

## Background

[//]: # "Explain what the concept is. If possible, relate it to another commonly known concept or software."
[//]: # "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."

---

## Use cases

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

### Use case 2

---

## Conclusion

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

---

## See also

[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
[//]: # "Link to related documents, such as reference material or task instructions."
17 changes: 2 additions & 15 deletions archetypes/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ nd-product:

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>.

---

## Before you begin

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

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

---

## Step 1

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

[//]: # "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."

---

### Sub-step 2

[//]: # "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."

---

## Step 2

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

### Sub-step 1

---

### Sub-step 2

---

## Step 3

[//]: # "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."

### Sub-step 1

---

### Sub-step 2

---

## See also
## Next steps

[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
[//]: # "Link to the most common use cases after this specific instruction. For example. configuration usually follows installation."
19 changes: 2 additions & 17 deletions archetypes/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ By the end of the tutorial, you should have enough working knowledge of <thing>

<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>.

---

## Before you begin

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

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

---

## Step 1

[//]: # "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."
Expand All @@ -61,8 +57,6 @@ The first thing required for setting up <thing> is <step name>. This is the <ser

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>.

---

### Sub-step 1

[//]: # "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."
Expand All @@ -87,34 +81,25 @@ To verify the creation of <component>, you can also inspect information about it
<the output of that command, possibly truncated and with changed IPs or domains>
```

---

### Sub-step 2

---

## Step 2

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

---

### Sub-step 1

---

### Sub-step 2

---

## Conclusion

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

---

## See also
## Next steps

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