From b1e9e23b2987b9efaebc2ad27dd585b523cf21fc Mon Sep 17 00:00:00 2001 From: Fabian Arrotin Date: Sep 29 2021 12:28:01 +0000 Subject: Added explanation about sigs.centos.org and ansible role for it Signed-off-by: Fabian Arrotin --- diff --git a/docs/apps/docs.md b/docs/apps/docs.md index e69de29..bd42f31 100644 --- a/docs/apps/docs.md +++ b/docs/apps/docs.md @@ -0,0 +1,20 @@ +# CentOS Documentation websites + +## CentOS official documentation + +## CentOS SIGs documentation + +We are hosting a "mkdocs-as-a-service" instance that SIGs can use to have [online documentation](https://sigs.centos.org). +It was decided to use [mkdocs](https://www.mkdocs.org) as it's easy to setup and it's just using MarkDown files, so easy to import/export if there is a need to migrate from (or migrate to) + +The workflow goes like this : + + * SIG have existing git project, hosting mkdocs.yml and docs/*.md files (see https://www.mkdocs.org/getting-started/) + * They create a ticket on our infra tracker asking to be added (SIG name, description and public git url - can be anywhere as long as it's public and so we can `git clone` it) + * Infra team is adding this in the `httpd_docs_sigs_list` ansible variables (host_vars) + * Every two minutes (by default), each enabled SIG will have its upstream git repo checked and site rendered/pushed if needed + +!!! note + Worth knowing that we are using a specific container with podman that has a specific theme ( [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) ) but all SIGs can decide to stick with a default theme present in the mkdocs app + +Link to [Ansible role](https://github.com/CentOS/ansible-role-httpd/blob/master/tasks/vhost-docs-sigs.yml)