GoogleForCreators / web-stories-wp

Web Stories for WordPress
https://wp.stories.google
Apache License 2.0
768 stars 178 forks source link

Decoupling from WordPress #8950

Closed mohdsayed closed 3 years ago

mohdsayed commented 3 years ago

Summary

In continuation with the epic https://github.com/google/web-stories-wp/issues/2918 "Editor Decoupling", I propose that the decoupling should be done in the following four steps.

1. Move all WordPress-related code from story-editor to wp-story-editor.

As story-editor package is supposed to be the core editor, it should be free from any WordPress-related code so that it can easily be integrated with any third-party platform. In this step, we would only remove any WordPress-specific code from the story-editor package and this task can be broken down into the following sub-tasks.

2. Move all WordPress-related code from dashboard to wp-dashboard.

Since the dashboard package has a similar code pattern to some extent, our learnings from step 1 would be helpful to move WordPress-specific code to the wp-dashboard package. It may need the following work.

3. Prepare an Integration layer API to allow the editor to be integrated with any third-party platform.

After completing step-1 and 2, we should naturally have an integration layer of the core editor and core dashboard with WordPress. However, it would still require some additional tasks for the editor to be integrated with any other platform ( Require Discussion ).

4. Prepare to publish the packages.

References

Related Issues and PRs https://github.com/google/web-stories-wp/issues/4737 https://github.com/google/web-stories-wp/pull/8573 https://github.com/google/web-stories-wp/pull/8561 https://github.com/google/web-stories-wp/pull/8646

swissspidy commented 3 years ago

I moved the summary here to #2918 as that epic actually has sub-tasks attached to it and is the existing go-to reference for all decoupling work.