Generate mermaid diagrams from JSON definitions #5
Conversation
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
mahmoud-elmorabea
force-pushed
the
MBL-1066-generate-mermaid-diagrams
branch
from
83f1d73 to
1d2ee0f
Compare
mahmoud-elmorabea
force-pushed
the
MBL-1066-generate-mermaid-diagrams
branch
from
1d2ee0f to
8255ee9
Compare
mahmoud-elmorabea
changed the title
mahmoud-elmorabea
requested review from
a team and
Shahroz16
and removed request for
Shahroz16
mahmoud-elmorabea
changed the base branch from
MBL-1065-automate-generating-json-logs-definition
to
main
mahmoud-elmorabea
force-pushed
the
MBL-1066-generate-mermaid-diagrams
branch
from
8255ee9 to
e29a9b3
Compare
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 creates a script that enables us to generate Mermaid diagrams to better visualize the JSON events definitions. Those diagrams will be used in the documentation to make it easier for stakeholders to digest the log events definitions.
I've created a PR #4 to show case generated mermaid diagrams