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 ded34ca commit 9ae1987
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions Documentation-as-DevOps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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)
-


0 comments on commit 9ae1987

Please sign in to comment.