diff --git a/docs/5._Controls_Internal/Workflows/writeDocu.md b/docs/5._Controls_Internal/Workflows/writeDocu.md index c072f18..c5fd97d 100644 --- a/docs/5._Controls_Internal/Workflows/writeDocu.md +++ b/docs/5._Controls_Internal/Workflows/writeDocu.md @@ -7,11 +7,11 @@ ## 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). +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/](https://linux.psi.ch/documentation/services/gitea/gitea-pages/) ## How to work with your own fork diff --git a/docs/5._Controls_Internal/Workflows/~writeDocu.md b/docs/5._Controls_Internal/Workflows/~writeDocu.md new file mode 100644 index 0000000..6ec70d8 --- /dev/null +++ b/docs/5._Controls_Internal/Workflows/~writeDocu.md @@ -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 Docum + +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 + +### Clone your name space version + +Text + +### Review your local changes + +Text + +### Merge into main Controls Documentation + +Text