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

website/developer-docs: add new template for procedures (#6390)

Browse Source 
* new templete for procedural topics

* edit sidebar

* removed backslash

* tweaks

* template draft

* fix sidebar

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Co-authored-by: Tana Berry <tana@goauthentik.io>
Co-authored-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
Tana M Berry
2023-08-03 13:41:27 -05:00
committed by GitHub
parent 5755a9a7c0
commit 81db2cf114
3 changed files with 69 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
website/developer-docs/docs/templates/index.md vendored Normal file
View File

@ -0,0 +1,15 @@
---
title: "Templates"
---
In technical docuemntation, there are document "types" (similar to how there are data types).
The most common types are:
- [**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**: these docs provide the WHY information, and explain when to use a feature (or when not to!), and general concepts behind the fature or functioanlity.
- **Reference**: this is typically tables or lists of reference information, such as configuration values, or most commmonly APIs.
We have templates for the different types, to make it super-easy for whomever wants to contribute some documentation!