-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
[#10623] Change design diagrams from Powerpoint to PlantUML #11956
[#10623] Change design diagrams from Powerpoint to PlantUML #11956
Conversation
General comment: It is OK to keep some diagrams in the current format if the PlantUML version can't be as visually expressive as the current version, especially if the diagram is not expected to change often e.g., Architecture-level diagrams |
Guys, This PR seems to be stalling (no activities for the past 7 days). 🐌 😢 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good effort!
Some suggestions for the high level architecture diagram:
-
Would be good if these 2 arrows can be separated more! Currently looks a bit confusing since the bottom arrow is pointing too close to the top arrow
-
The PlantUML diagram makes it seem like GAE is entirely separate from the rest of the architecture, would be good to shift it directly below Datastore or add an arrow/line to link the two together
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for the changes!
Guys, This PR seems to be stalling (no activities for the past 7 days). 🐌 😢 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, kindly update the branches to be ready for merging
…EAMMATES#11956) * convert Actors.pptx to puml * convert highlevelArchitecture.pptx to puml * migrate IssueLifecycle to puml * update styling based on comments Co-authored-by: Zhao Jingjing <54243224+zhaojj2209@users.noreply.github.com>
Part of #10623
Outline of Solution
The diagrams that I have converted are very heavily customized (different colors and line styles were used) and as such there were a lot of inline styling that were done. I am still quite new to PlantUML so I'm not too sure whether these customizations can be done in a better way, but I have represented the original images as best as I can in puml.
For the remaining 2 pptx files (
RolesAndTechnologies
andworkflow
), I stand with the previous committer that puml is not sufficient to represent the information presented