Skip to content

Commit

Permalink
Update Documentation-as-DevOps.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
khazelton authored May 26, 2023
1 parent 0567566 commit 6d32d93
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions Documentation-as-DevOps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 6d32d93

Please sign in to comment.