webiste/docs: Improve clarity of dev environment setup doc (#3045)

* Improve clarity of dev environment setup doc

* Requested changes and further small improvements

* I actually read the makefile this time

* Add makefile entry for building ui

* Comments

* Add documentation setup

* Move documentation setup

* Formatting
This commit is contained in:
Keval Kapdee
2022-06-05 22:26:08 +01:00
committed by GitHub
parent 8d3275817b
commit 6f3d6efa22
3 changed files with 36 additions and 20 deletions

View File

@ -5,7 +5,23 @@ title: Writing documentation
Writing documentation for authentik is a great way for both new and experienced users to improve and contribute to the project. Here are a few guidelines to ensure
the documentation is easy to read and uses similar phrasing.
# General guidelines
## Setup
Requirements:
- Node 16 (or greater)
The documentation site is situated in the `/website` folder of the authentik GitHub repository.
The site is built using npm, below are some useful make commands:
- Install: `make website-install` (Needed for any of the other tasks)
- Formatting: `make website-lint-fix` or `make website` (Run this before committing)
- Live editing: `make website-watch` (For real time viewing of changes)
Be sure to run the formatter before committing changes.
## General guidelines
- authentik should always be stylized as `authentik` (with a lower-case a and ending with a k)
- Documentation should use American english