docs: remove excess files from diagram autogeneration and disable titles in generated diagrams #847
Conversation
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
edibotopic
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #847 +/- ##
==========================================
+ Coverage 88.29% 88.33% +0.04%
==========================================
Files 105 105
Lines 6757 6757
==========================================
+ Hits 5966 5969 +3
+ Misses 616 613 -3
Partials 175 175 ☔ View full report in Codecov by Sentry. |
edibotopic
force-pushed
the
change-c4-diagram-rendering-backend
branch
from
af478f9 to
5ab172e
Compare
edibotopic
force-pushed
the
change-c4-diagram-rendering-backend
branch
from
5ab172e to
f6bf160
Compare
[Auto-generated pull request](https://github.com/canonical/ubuntu-pro-for-wsl/actions/workflows/autoupdate-structurizr-diagrams.yml) by GitHub Action
edibotopic
changed the title
CarlosNihelton
approved these changes
Jul 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aimed to (1) reduce the number of excess files that are created in the repo during autogeneration of C4 diagrams and (2) leverage config options passed to the renderer to disable excess information in the diagrams, such as titles.
Originally, switching to an alternative rendering backend was trialled for (1) but this failed during test workflow runs.
The alternative solution was to simply remove unwanted files with
rmin the workflow after generation.The workflow already removes junk generated during each run (.puml files), so it has now been amended to also remove key/legend files, which are not useful for our purposes. This removed 11 files of ~110 kb.
The existing plantuml rendering backend has limited config options but allows titles to be disabled in diagrams. This change was made and helps reduce visual noise in what are already already complex diagrams. This also prevents naming conflicts; for example, terms like "landscape" and "container" are included in titles (according to the C4 convention) but these could cause confusion when a technology called "Landscape" is also being referenced in a diagram and "container" has a variety of uses in software.
The alt text used for one of the images in the docs was also fixed as it wasn't fit-for-purpose.
UDENG-3731