writing docu added
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
# Writing Controls Documentation
|
||||
|
||||
## Different Types of Docu
|
||||
|
||||
[The Grand Unified Theoriy of Documentation](https://docs.divio.com/documentation-system/)
|
||||
|
||||
## How to publish Controls Documentation
|
||||
|
||||
Everything is automated. The changes are rendered as soon as you push to the gitea
|
||||
repository [](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/)
|
||||
|
||||
## 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
|
||||
|
||||
### Clone your name space version
|
||||
|
||||
Text
|
||||
|
||||
### Review your local changes
|
||||
|
||||
Text
|
||||
|
||||
### Merge into main Controls Documentation
|
||||
|
||||
Text
|
||||
@@ -1,7 +1,5 @@
|
||||
# Overview
|
||||
|
||||
elke was here
|
||||
|
||||
Description of the documentation structure.
|
||||
|
||||
## Who are we?
|
||||
|
||||
Reference in New Issue
Block a user