UML made easy with plantuml vs code
https://www.codeproject.com/Articles/1278703/UML-Made-Easy-with-PlantUML-VS-Code
The hitchhikers guide to PlantUML
https://crashedmind.github.io/PlantUMLHitchhikersGuide/
plantuml markdown code gitlab github integration
https://docs-as-co.de/news/plantuml-markdown-code-gitlab-github-integration/
https://support.typora.io/Draw-Diagrams-With-Markdown/
https://mermaid-js.github.io/mermaid/#/gantt
https://gist.github.com/rodneyrehm/40e7946c0cff68a31cea
My notes
- What is PlantUML?
- Installing PlantUML
- create file with puml or example file extension
- copy in example code
- hit Alt+d for preview
There is a _docs folder in every folder that needs diagrams or hlds.
- all these files are markdown or puml
- The PlantUML diagrams are generated and saved into the _docs folder
- The markdown files are generated and saved into the _docs folder as Word documents and possibly powerpoint documents.
- All those files are built and deployed to a wiki somewhere…
- github actions detects a change to to a /docs/ file in any branch, it then grabs that branch, generated the diagrams and word documents (do I need word docs?). And pushes the files all into the wiki.
- Wiki is laid out by version numbers.
- Folder structure:
- Wiki (https://github.com/gollum/gollum/wiki/Screenshots ?)
- infrastructure
- management_groups
- connectivity
- identity
- landing-zones
- jira
- bjj-dojos versions - L1.0.1 (live) - L1.0.0 - rc1.0.1 - l1.0.0 - f1.1.0 - Markdown files - generated diagrams
- management_groups
- infrastructure
- Wiki (https://github.com/gollum/gollum/wiki/Screenshots ?)