Skip to content

Commit

Permalink
add basic documentation for viewing/generating plantUML diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
mark-meyer committed Sep 25, 2023
1 parent efb1b25 commit f9b0997
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
6 changes: 5 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
{
"recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
"recommendations": [
"vue.volar",
"vue.vscode-typescript-vue-plugin",
"jebbs.plantuml"
]
}
8 changes: 8 additions & 0 deletions docs/diagrams/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# System Diagrams

This directory contains plantUML files for creating various system diagrams documenting the SmartPay systems inlcuding the website, training site, and the 889 tool. These are primarily used for ATO documentation, but should be kept up-to-date when changes are made to the system.

See [https://plantuml.com](https://plantuml.com) for documentation.

## Viewing and exporting
There are multiple way to process and view plantUML. [Quick Start Guide to PlantUML](https://plantuml.com/starting) has links to various tools. We have found the easiest way to manage these files is with the VS Code [PlantUML extension](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml). With this extension installed you can use Alt + D to start PlantUML preview (option + D on MacOS). Right clicking in the plantUML file will also bring up a contextual menu to export the files.

0 comments on commit f9b0997

Please sign in to comment.