Skip to content
This repository has been archived by the owner on Feb 24, 2022. It is now read-only.

Add PlantUML source and rendered diagrams #31

Merged
merged 4 commits into from
Jan 10, 2022
Merged

Add PlantUML source and rendered diagrams #31

merged 4 commits into from
Jan 10, 2022

Conversation

mogul
Copy link
Collaborator

@mogul mogul commented Jan 7, 2022

Addresses #5

mogul added 3 commits January 7, 2022 14:42
This just makes it easy for anyone using VSCode+PlantUML to land rendered documents in the right place.
@pburkholder pburkholder self-assigned this Jan 7, 2022
pburkholder
pburkholder previously approved these changes Jan 7, 2022
Copy link
Collaborator

@pburkholder pburkholder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These work for me in VSCode. I think including AWS in deployment-change.md is confusing since AWS should be an abstraction layer under cloud.gov. But for getting initial compliance conversations going this will work.

@pburkholder
Copy link
Collaborator

Also, unless you've set up vscode to use a local install of the plantUML server, you are exfiltrating all your architecture to an external service. See https://github.com/cloud-gov/cg-diagrams/tree/peterb/jab_diagrams#federalistpages-diagrams for one way to use a local Docker renderer.

@pburkholder pburkholder removed their assignment Jan 7, 2022
Copy link
Collaborator

@rahearn rahearn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great starting point, and I love the inline plantuml rendering and workflow. Just updated the README with information about the plantuml server that @pburkholder mentioned.

One question I have that can be answered after merge, what's the purpose of the generic folder? Seems like a starting point for various cloud.gov diagrams, but in that case wouldn't it be better kept in a single central repo, rather than alongside each repo that is using it?

@rahearn rahearn merged commit ac27acb into main Jan 10, 2022
@rahearn rahearn deleted the add-diagrams branch January 10, 2022 14:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants