Skip to content

Commit

Permalink
chore(docs): update existing diagrams (#1187)
Browse files Browse the repository at this point in the history
## Description
Update existing diagrams to use company branding (colors, topography,
logo). Also include the draw.io file in this repo for source control
reasons.

## Related Issue

Relates to #1185 

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor
Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md)
followed

---------

Co-authored-by: Micah Nagel <[email protected]>
  • Loading branch information
UnicornChance and mjnagel authored Jan 17, 2025
1 parent 00e89ff commit 6f0fda2
Show file tree
Hide file tree
Showing 5 changed files with 1,656 additions and 8 deletions.
13 changes: 8 additions & 5 deletions docs/.images/diagrams/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,17 @@ At this time there are three layers to our diagram that visually explain the fol

3. `Ports and Protocols`, similar to `Traffic Direction` layer with the addition of ports and protocols.

## How to Customize
To customize the diagram, download the svg and in [draw.io](https://draw.io) create a new diagram and load in the svg.
## Making Changes to Diagrams for UDS Core

To download the [svg from github](https://github.com/defenseunicorns/uds-core/tree/main/docs/.images), select one of the svg files, then select the download button in the top right of the `Preview` view.
Utilize the drawio file to make changes across all diagrams. Make sure that changes are exported in the svg format and put into this directory if being used in the docs as well as any changes to the drawio file.

Alternatively you can also download the svg from the [uds.defenseunicorns.com](https://uds.defenseunicorns.com/reference/uds-core/overview/) docsite by right clicking and selecting the `Save image as` option.
## How to Customize For Outside Use
Utilize the drawio file included in this directory to access all of the diagrams in one place.

To customize a specific diagram, download the svg and in [draw.io](https://draw.io) create a new diagram and load in the svg.

It doesn't matter which svg you download, they all contain the metadata for the other layers mentioned above (you may need to enable the layers pop up in [draw.io](https://draw.io) to change your layer).
To download the [svg from github](https://github.com/defenseunicorns/uds-core/tree/main/docs/.images/diagrams), select one of the svg files, then select the download button in the top right of the `Preview` view.

Alternatively you can also download the svg from the [uds.defenseunicorns.com](https://uds.defenseunicorns.com/reference/uds-core/overview/) docsite by right clicking and selecting the `Save image as` option.

#### If you have suggestions for the diagrams, we welcome issues or pull requests contributions to [uds-core](https://github.com/defenseunicorns/uds-core).
2 changes: 1 addition & 1 deletion docs/.images/diagrams/uds-core-arch-ingress-egress.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/.images/diagrams/uds-core-arch-overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/.images/diagrams/uds-core-arch-ports-protocols.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,645 changes: 1,645 additions & 0 deletions docs/.images/diagrams/uds-core-architecture-diagrams.drawio

Large diffs are not rendered by default.

0 comments on commit 6f0fda2

Please sign in to comment.