Skip to content
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

Merged
merged 1 commit into from
Jun 23, 2021

Conversation

youknowriad
Copy link
Contributor

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.
WordPress Post Editor

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Jun 23, 2021
@youknowriad youknowriad self-assigned this Jun 23, 2021
@youknowriad youknowriad requested a review from mkaz June 23, 2021 11:59
@@ -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)
Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Member

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.

Copy link
Contributor

@ntsekouras ntsekouras left a 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!

@youknowriad youknowriad merged commit 1454a7e into trunk Jun 23, 2021
@youknowriad youknowriad deleted the add/modules-architecture branch June 23, 2021 15:12
@github-actions github-actions bot added this to the Gutenberg 11.0 milestone Jun 23, 2021
@gziolo
Copy link
Member

gziolo commented Jul 9, 2021

This is great. Thank you for including this very helpful schema.

I see you added modules.excalidraw file to the commit. Does it mean that the schema can be recreated and modified?

@youknowriad
Copy link
Contributor Author

@gziolo yes, you can take that file and open it in excalidraw to make updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants