habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/docs: added a new template for "combo" topics (#8595)

Browse Source 
* add combo template

* added md template

* add md file

* add more in section

* typo
This commit is contained in:
Tana M Berry
2024-02-21 15:28:44 -06:00
committed by GitHub
parent 55d08c5be3
commit 1457b38e7e
3 changed files with 100 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/developer-docs/docs/templates/index.md vendored
View File

@ -6,6 +6,8 @@ In technical documentation, there are document "types" (similar to how there are
The most common types are:
- [**Combo**](./combo.md): For most topics (unless they are very large and complex), we can combine the procedural and conceptual information into a single document. A handy guideline to follow is: "If the actual 1., 2., 3. steps are buried at the bottom, and a reader has to scroll multiple times to find them, then the combo approach is _not_ the right one".
- [**Procedural**](./procedural.md): these are How To docs, the HOW information, with step-by-step instructions for accomplishing a task. This is what most people are looking for when they open the docs... and best practice is to separate the procedural docs from long, lengthy conceptual or reference docs.
- [**Conceptual**](./conceptual.md): these docs provide the WHY information, and explain when to use a feature (or when not to!), and general concepts behind the feature or functionality.