Skip to content

Commit 1c54cb5

Browse files
authored
Adding a template for guides (#504)
* Adding a template for guides
1 parent 64fe75a commit 1c54cb5

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

docs/Contribute-to-Documentation.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,87 @@ We kindly ask that all members respect each other's diverse skills and abilities
9696
:::
9797

9898
AlmaLinux Wiki documentation is written with [Markdown](https://www.markdownguide.org/basic-syntax/). Some HTML elements can also be used.
99+
Please, refer to the template in the *details* and to this [page](/elevate/ELevate-quickstart-guide) as the example.
100+
:::details
101+
```
102+
---
103+
title: ' '
104+
---
105+
106+
# Title of the Guide
107+
108+
###### last updated: YYYY-MM-DD
109+
110+
or
111+
112+
| Experience Level | ⭑⭑⭒⭒⭒ (Intermediate) |
113+
|--------------------|---------------------- |
114+
| Last modified date | YYYY-MM-DD |
115+
116+
## About
117+
118+
A brief description, purpose of the guide. What will users achieve by following it?
119+
120+
## Prerequisites
121+
122+
List all necessary prerequisites, such as:
123+
* Software or hardware required.
124+
* User permissions needed.
125+
* Prior knowledge or skills.
126+
127+
Example:
128+
* Operating System: Linux (Windows/MacOS if applicable)
129+
* Software: Git, Docker, etc.
130+
* Access Level: Admin rights required, etc.
131+
132+
## Step-by-Step Instructions
133+
134+
### Part 1
135+
136+
Describe steps in detail. Use code blocks, tables, lists, and images as necessary.
137+
Highlight any important notes or warnings if applicable using markdown tips/warnings.
138+
139+
* Step 1
140+
* Step 2
141+
142+
**Example:**
143+
(Code block or output example)
144+
145+
### Part 2
146+
147+
Describe the next step in detail. Use code blocks, tables, lists, and images as necessary.
148+
Highlight any important notes or warnings if applicable.
149+
150+
* Step 1
151+
* Step 2
152+
153+
**Example:**
154+
(Code block or output example)
155+
156+
## Additional Resources
157+
158+
Provide links to external documentation, tutorials, or resources for further learning.
159+
160+
* Resource 1
161+
* Resource 2
162+
* Official Documentation
163+
164+
## Troubleshooting/Known Issues
165+
Include any common/known issues that users can face and how to resolve them.
166+
167+
### Issue 1: Description of issue.
168+
169+
Solution: Steps to solve the issue.
170+
171+
### Issue 2: Another issue.
172+
173+
Solution: Another solution.
174+
175+
## Get Help
176+
177+
Provide any links to forums/chats where users can report their bugs, ask for any help, assistance or reach out with their feedback.
178+
```
179+
:::
99180

100181
All the content is located in the `/wiki/docs` directory.
101182

0 commit comments

Comments
 (0)