-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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 a schema explaining the relationship between the packages that make the post editor #32921
Conversation
…e the post editor
@@ -78,6 +78,8 @@ These are packages used in development mode to help developers with daily tasks | |||
|
|||
## Editor Packages | |||
|
|||
![Post Editor Modules Architecture](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/explanations/architecture/assets/modules.png) |
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.
I noticed that there's a number of assets that we link to like that (using a GitHub link). I assume we explored alternatives in the past. Anyone know why we settled on this? This doesn't sound ideal to me because we always link to the "trunk" version of the files.
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.
We looked at uploading files to dot-org and linking them (I think a few assets may be linked that way?) but ultimately didn't go for it because it would have required coordinating auth permissions for people.
It might be possible to use relative links, which I think would make GitHub use the current branch/commit view instead of trunk, but I don't think that would translate to DevHub without some extra work on the meta side.
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.
Should we create another repository in the WordPress organization to keep all images and use the same permissions for users as they exist in Gutenberg?
There are 35 images referenced in the documentation at the moment that are hosted together with the source code. The image included in this PR alone is nearly 1 MB, so those assets (and their previous versions kept in git history) might have some bigger impact on the download size when cloning the repository.
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.
That's really nice Riad - thank you!
This is great. Thank you for including this very helpful schema. I see you added |
@gziolo yes, you can take that file and open it in excalidraw to make updates. |
This PR adds both the png of the schema and an excalidraw file to be able to edit it in the future in excalidraw.com if needed.