Repository navigation
docs: make the overview system map readable on GitHub - #235
Merged
Merged
Conversation
Lay the diagram out top-down, keep arrow labels to a few words and move endpoints, tokens and signatures into a Connections table below it.
This file contains hidden or 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
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.
The problem
The system map in
docs/how-it-works/01-overview.mdis so wide that GitHub shrinks it until the text is too small to read. To read it, you have to open the full-screen viewer and pan around. The diagram ran left to right through 6–7 columns, arrows going back and forth (portal ↔ Triage, Connector ↔ Backoffice) stretched it further, and arrow labels like "signed webhook (ES256) to Client.url" made the gaps between columns wider still. Rendered locally, it was about 3,100 px wide.Solution
This PR fixes only the overview diagram. The other wide diagrams (mostly the sequence diagrams in 03, 05 and 07) are wide for a different reason, long text on the arrows, so they'll each get their own PR.
flowchart TD), so it grows downwards.jobs <--> Triage,conn <--> BO), and the email arrow is written the other way round (rsuser <-.- mail). Without that, the top-to-bottom layout came out upside down, with the citizen at the bottom and Backoffice at the top.REST,JWT,RS emails). The endpoints, tokens and signatures moved to a new Connections table under the diagram, one row per arrow.While writing the table I checked the auth details against the code and filled in two that the old diagram left out:
TRIAGE_ZAMMAD_API_TOKEN(ApiControllerusesTriageZammadEnvironment.client).X-Hub-Signaturewith the tenant's webhook secret (app/controllers/connector/backoffice/webhooks_controller.rb).Rendered locally with mermaid-cli, the diagram is about 1,500 px wide instead of 3,100 px.
Verify: open the file on this branch on GitHub and check that the system map reads without zooming.
Demo
Rendered
01-overview.mdon this branch, compare withmain.Checklist
docs/how-it-works/is updated, or this PR changes no flow (job, webhook, Triage or Backoffice trigger, issue state, email, scheduled job)