Skip to content
Permalink
chubing
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

iam-knowledge-bits/its.adoc

Go to file
@khazelton
khazelton Update its.adoc
Latest commit 58690a3 May 26, 2023 History
1 contributor

Users who have contributed to this file

Documentation-as-DevOps One Option DevOps approach to Documentation: Reference materials
35 lines (28 sloc) 2.18 KB
Raw Blame

Static site generators as documentation substrate

  1. MkDocs

  2. Jekyll

  3. GitHub Pages

  4. GitLab Pages

  5. Docusaurus

  6. Antora

  7. Hugo

Documentation-as-DevOps

One Option

  1. Review Evolveum Documentation: https://docs.evolveum.com/, and their writing processes: https://docs.evolveum.com/about/writing-documentation/, https://docs.evolveum.com/about/asciidoc/

  2. Migrate existing content from Confluence XHTML to asciidoc: https://docs.asciidoctor.org/asciidoctor/latest/migrate/confluence-xhtml/

  3. Create and edit new and existing files with asciidoc, push to a github repo

  4. Include PlanntUML, C4, and output from additional diagramming tools with the asciidoctor extension for kroki: https://github.com/ggrossetie/asciidoctor-kroki, https://kroki.io/

  5. Create an Antora site to host the asciidoc files

  6. 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

  7. 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

DevOps approach to Documentation: Reference materials