From 6d32d93ee6190114143eb3f9001c21954e9cc5a2 Mon Sep 17 00:00:00 2001 From: Keith Hazelton Date: Fri, 26 May 2023 07:44:51 -0500 Subject: [PATCH] Update Documentation-as-DevOps.adoc --- Documentation-as-DevOps.adoc | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/Documentation-as-DevOps.adoc b/Documentation-as-DevOps.adoc index 81144a6..a4d0dbb 100644 --- a/Documentation-as-DevOps.adoc +++ b/Documentation-as-DevOps.adoc @@ -3,12 +3,10 @@ ==== 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/ -. Migrate existing content from Confluence XHTML to asciidoc: https://docs.asciidoctor.org/asciidoctor/latest/migrate/confluence-xhtml/ -. Create and edit new and existing files with , push to a github repo -. Include PlanntUML, C4, and output from additional diagramming tools with the asciidoctor extension for kroki: https://github.com/ggrossetie/asciidoctor-kroki, https://kroki.io/ . Create an Antora site to host the asciidoc files -. Anrtora Assembler: add-on library and extension that assembles content from multiple pages into aggregate documents, converts them to the specified output format, and publishes them alongside other files in the site https://gitlab.com/antora/antora-assembler -. Follow Antora guidance to create a pipeline to rebuild the site whenever content is added, edited, or deleted: https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=&ved=2ahUKEwiB5IfittT-AhWVk4kEHR9zBwQQFnoECBcQAQ&url=https%3A%2F%2Fdocs.antora.org%2Fantora%2Flatest%2Fpublish-to-gitlab-pages%2F&usg=AOvVaw3vOCafAF8DhwsRqTQbeFcm +. 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/ + ==== DevOps approach to Documentation: Reference materials - Evolveum documentation site: https://docs.evolveum.com