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

website/docs: added conceptual template (#6518)

Browse Source 
added conceptual template

Co-authored-by: Tana Berry <tana@goauthentik.io>
This commit is contained in:
Tana M Berry
2023-08-10 10:21:53 -05:00
committed by GitHub
parent 8fb0d7be2a
commit 9bdda11c88
3 changed files with 25 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,8 +8,8 @@ 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 feature or functioanlity.
- [**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.
- **Reference**: this is typically tables or lists of reference information, such as configuration values, or most commmonly APIs.
- **Reference**: this is typically tables or lists of reference information, such as configuration values, or functions, or most commmonly APIs.
We have templates for the different types, to make it super-easy for whomever wants to contribute some documentation!