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

website/dev-docs: add raw markdown template (#6768)

Browse Source 
* add raw markdown template

* changed to truly raw markdown file

* fix download link

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-09-06 08:04:35 -05:00
committed by GitHub
parent d79ed5a152
commit 5ea67398ae
4 changed files with 48 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
website/developer-docs/docs/writing-documentation.md
View File

@ -52,8 +52,8 @@ Be sure to run the formatter before committing changes.
- When referring to UI text or UI components in authentik, use **bold** text.
- When referring to other objects in authentik code or functionality, use _cursive_ text, and link to the corresponding documentation if possible.
- When referring to external tools, give an example how to use the tools or explain how the user can use them.
- Make sure to add the documentation to add to the sidebar, if adding a new page.
- Test how the documentation renders using the Netlify Deploy Preview, especially when using Docusaurus-specific features.
- Make sure to add the documentation to the sidebar, if adding a new page.
- Test how the documentation renders using the Netlify Deploy Preview, especially when using Docusaurus-specific features. Or build it locally and test, using the `make website-watch` command.
If you find any documentation that doesn't match these guidelines, feel free to either open an [Issue](https://github.com/goauthentik/authentik/issues) or a [PR](https://github.com/goauthentik/authentik/pulls) so they can be fixed.