From 348f91ce32a18c35dbe3263538bd2ce371881042 Mon Sep 17 00:00:00 2001 From: Elke Zimoch Date: Mon, 29 Jun 2026 16:37:37 +0200 Subject: [PATCH] writing docu added --- .../Workflows/writeDocu.md | 37 +++++++++++++++++++ docs/index.md | 2 - 2 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 docs/5._Controls_Internal/Workflows/writeDocu.md diff --git a/docs/5._Controls_Internal/Workflows/writeDocu.md b/docs/5._Controls_Internal/Workflows/writeDocu.md new file mode 100644 index 0000000..c072f18 --- /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 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 diff --git a/docs/index.md b/docs/index.md index ef5bffe..d032ea1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,5 @@ # Overview -elke was here - Description of the documentation structure. ## Who are we?