From 9ae19875267c5ff91b98a8240af358b92fa30a47 Mon Sep 17 00:00:00 2001 From: Keith Hazelton Date: Fri, 26 May 2023 08:15:48 -0500 Subject: [PATCH] Update Documentation-as-DevOps.adoc --- Documentation-as-DevOps.adoc | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/Documentation-as-DevOps.adoc b/Documentation-as-DevOps.adoc index a4d0dbb..3769da7 100644 --- a/Documentation-as-DevOps.adoc +++ b/Documentation-as-DevOps.adoc @@ -3,15 +3,27 @@ ==== Proposal . Review Evolveum Documentation: https://docs.evolveum.com/, and their writing processes: https://docs.evolveum.com/about/writing-documentation/, https://docs.evolveum.com/about/asciidoc/ -. Create an Antora site to host the asciidoc files +. . Create and edit new and existing files with mmarkdown or asciidoc, push to the site repo . Include support forPlanntUML, C4, and output from additional diagramming tools with an extension for kroki: https://kroki.io/ +The documentation branch of the Docsy example site follows the '4 kinds of documentation' model: https://documentation.divio.com/ -==== DevOps approach to Documentation: Reference materials +.Docsy and the Four Types of Documentation +[width="70%",options="header"] +|======= +| 4 types of documentation | Docsy Example Site Documentation Page +| tutorials | Tutorials +| how-to's | Core Tasks +| explanation | Concepts +| reference | Reference +|======= + + +==== DevOps approach to Documentation: Reference Materials - Evolveum documentation site: https://docs.evolveum.com - Asciidoc: https://asciidoc.org - Markdown: https://www.markdownguide.org/ - Github Pages: https://pages.github.com (Auto Re-Publication on commit to repo) -- +