54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
# Writing Controls Documentation
|
|
|
|
## Different Types of Docu
|
|
|
|
[The Grand Unified Theoriy of Documentation](https://docs.divio.com/documentation-system/)
|
|
|
|
## How to publish Controls Docu
|
|
|
|
Everything is automated. The changes are rendered as soon as you push to the gitea
|
|
repository [https://gitea.psi.ch/Controls/gitea-pages](https://gitea.psi.ch/Controls/gitea-pages).
|
|
|
|
The webpage is generated from markdown files using Zensical together with Gitea Actions.
|
|
The process to setup such page is described here
|
|
[https://linux.psi.ch/documentation/services/gitea/gitea-pages/](https://linux.psi.ch/documentation/services/gitea/gitea-pages/)
|
|
|
|
## How to work with your own fork
|
|
|
|
If several people work at the same time on the same repository but on different files,
|
|
it can help to create your own fork in your own gitea name space. This will make it
|
|
easier to debug zensical rendering errors and layout changes without disturbing
|
|
colleagues.
|
|
|
|
### Fork into your name space
|
|
|
|
Text
|
|
|
|
|
|
|
|
Text2
|
|
|
|
|
|
|
|
Text4
|
|
|
|
### Clone your name space version
|
|
|
|
Text3
|
|
|
|
|
|
|
|
Text
|
|
|
|
|
|
|
|
Text3
|
|
|
|
### Review your local changes
|
|
|
|
Text
|
|
|
|
### Merge into main Controls Documentation
|
|
|
|
Text
|