-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add basic documentation for viewing/generating plantUML diagrams
- Loading branch information
1 parent
efb1b25
commit f9b0997
Showing
2 changed files
with
13 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |