-
Notifications
You must be signed in to change notification settings - Fork 130
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
Add diagrams from draw.io #122
Conversation
I'm trying to figure out how best to share these in such a way that we can all contribute to them easily. While integration between draw.io and GitHub exists, it requires read/write permissions to all ParityTech repos, which doesn't comfort me. I think having the .drawio file and the corresponding pictures available in a folder is a good start. I imagine the workflow would be something like this: Someone wants to update a diagram, so they go to draw.io and upload the .drawio file from the repo. They make their changes, download the new .drawio file and corresponding SVG, and commit their changes to the repo.
The workflow looks okay to me for start.
We can just have a md file in the repo that embeds the SVG. Or set up the wiki so that it's generated from files in the repo - I'd prefer to have it version controlled. Comments to the diagrams:
Looks pretty good overall, I think adding text descriptions will clear more things up. |
The background for each diagram has been removed (now it's transparent) and the boxes that make up the diagrams have gotten a filled in white colour. This will make it possible to have these diagrams show up on non-white backgrounds.
So I made the background for each diagram transparent (you need to tick a box when you export them from draw.io), and I filled in all the actual diagram boxes to white. I've also dumped the diagrams in an ARCHITECTURE.md file. I'm not super keen on making write ups for them right now, but if you guys think that it should be required as part of this PR I can do it. Also, regarding this:
I think this is a larger discussion outside the scope of this PR, but it's good that these visualizations can help us get an idea of what we each understand about the project so we can work towards a common consensus :) |
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.
Looks good to me, fine with having write-ups be a separate PR (or even just log an issue, probably a good one for a start for someone).
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.
Had the same concern about cross-chain-fund-transfer.svg - there's no auto-relaying tx proofs now. But as long as it is known, I'm ok with that.
I'm trying to figure out how best to share these in such a way that we
can all contribute to them easily. While integration between draw.io
and GitHub exists, it requires read/write permissions to all ParityTech
repos, which doesn't comfort me. I think having the .drawio file and
the corresponding pictures available in a folder is a good start.
I imagine the workflow would be something like this: Someone wants to
update a diagram, so they go to draw.io and upload the .drawio file
from the repo. They make their changes, download the new .drawio file
and corresponding SVG, and commit their changes to the repo.
I plan to make a Wiki page for showing these diagrams off and possibly
going into more in-depth explanations about certain things.