Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace high level architecture diagram with editable PNG #3059

Merged
merged 2 commits into from
Jan 12, 2024

Conversation

tcdowney
Copy link
Member

Is there a related GitHub Issue?

No, but there is a Slack discussion on this here.

What is this change about?

The previous diagram (and other existing diagrams) were created in a Miro whiteboard that other contributors do not have access to. This replaces it with a https://www.drawio.com/ PNG with embedded diagram metadata that can be opened and edited by anyone. Going forward we should update the other diagrams and make sure new diagrams are produced using DrawIO or similar tooling.

Does this PR introduce a breaking change?

No

Acceptance Steps

Verify that the diagram renders in the arch docs and attempt to download and edit the png on https://draw.io.

Tag your pair, your PM, and/or team

@danail-branekov @PureMunky @davewalter

- The previous diagram (and other existing diagrams) were created
in a Miro whiteboard that other contributors do not have access to
- This replaces it with a https://www.drawio.com/ PNG with embedded
diagram metadata that can be opened and edited by anyone
@tcdowney tcdowney added the documentation Improvements or additions to documentation label Jan 12, 2024
Copy link
Member

@davewalter davewalter left a comment

Choose a reason for hiding this comment

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

Looks good.

@tcdowney tcdowney enabled auto-merge (squash) January 12, 2024 22:49
@tcdowney tcdowney merged commit d061303 into main Jan 12, 2024
11 checks passed
@tcdowney tcdowney deleted the update-high-level-arch-diagram branch January 12, 2024 22:51
Copy link
Member

@danail-branekov danail-branekov left a comment

Choose a reason for hiding this comment

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

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants