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

[Documentation] Create new page listing Gutenberg releases in each WordPress version #23773

Merged
merged 6 commits into from
Jul 9, 2020

Conversation

annezazu
Copy link
Contributor

@annezazu annezazu commented Jul 7, 2020

Fixes #23344

This new page should have Project Overview as the parent. This addresses concerns brought up in #23344 and should make life easier for those trying to figure out what version of Gutenberg are present in each WordPress release. Of note, I included 5.5 here in light of this recent post: https://wordpress.org/news/2020/07/wordpress-5-5-beta-1/

I wasn't sure how to set a parent page so apologies if I did this wrong! Would love to learn how to do this for future reference.

This new page should have Project Overview as the parent. This addresses concerns brought up in #23344.
@annezazu annezazu added [Type] Enhancement A suggestion for improvement. [Type] Developer Documentation Documentation for developers labels Jul 7, 2020
@github-actions
Copy link

github-actions bot commented Jul 7, 2020

Size Change: +2.21 kB (0%)

Total Size: 1.14 MB

Filename Size Change
build/block-editor/index.js 115 kB -76 B (0%)
build/block-editor/style-rtl.css 10.8 kB +1 B
build/block-editor/style.css 10.8 kB +1 B
build/block-library/editor-rtl.css 7.6 kB +54 B (0%)
build/block-library/editor.css 7.59 kB +54 B (0%)
build/block-library/index.js 132 kB +1.61 kB (1%)
build/block-library/style-rtl.css 7.77 kB +13 B (0%)
build/block-library/style.css 7.77 kB +13 B (0%)
build/blocks/index.js 48.2 kB +22 B (0%)
build/components/index.js 199 kB +305 B (0%)
build/components/style-rtl.css 15.9 kB +28 B (0%)
build/components/style.css 15.8 kB +24 B (0%)
build/compose/index.js 9.67 kB +107 B (1%)
build/date/index.js 5.38 kB +3 B (0%)
build/edit-navigation/index.js 10.8 kB +1 B
build/edit-post/index.js 304 kB -2 B (0%)
build/edit-post/style-rtl.css 5.59 kB +17 B (0%)
build/edit-post/style.css 5.58 kB +17 B (0%)
build/edit-site/index.js 16.6 kB +2 B (0%)
build/editor/index.js 45.1 kB +32 B (0%)
build/format-library/index.js 7.72 kB +1 B
build/keyboard-shortcuts/index.js 2.51 kB -4 B (0%)
build/list-reusable-blocks/index.js 3.12 kB -2 B (0%)
build/media-utils/index.js 5.32 kB -3 B (0%)
build/plugins/index.js 2.56 kB -1 B
build/server-side-render/index.js 2.71 kB +1 B
build/token-list/index.js 1.27 kB -2 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.67 kB 0 B
build/api-fetch/index.js 3.39 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 7.67 kB 0 B
build/block-directory/style-rtl.css 944 B 0 B
build/block-directory/style.css 945 B 0 B
build/block-library/theme-rtl.css 728 B 0 B
build/block-library/theme.css 729 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/core-data/index.js 11.4 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.46 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 569 B 0 B
build/dom/index.js 3.23 kB 0 B
build/edit-navigation/style-rtl.css 1.08 kB 0 B
build/edit-navigation/style.css 1.08 kB 0 B
build/edit-site/style-rtl.css 3.03 kB 0 B
build/edit-site/style.css 3.03 kB 0 B
build/edit-widgets/index.js 9.35 kB 0 B
build/edit-widgets/style-rtl.css 2.45 kB 0 B
build/edit-widgets/style.css 2.45 kB 0 B
build/editor/editor-styles-rtl.css 537 B 0 B
build/editor/editor-styles.css 539 B 0 B
build/editor/style-rtl.css 3.78 kB 0 B
build/editor/style.css 3.78 kB 0 B
build/element/index.js 4.65 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 709 B 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/primitives/index.js 1.4 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 13.9 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.13 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

Copy link
Contributor

@talldan talldan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting this together @annezazu!

I noticed the file needs the markdown .md extension, and also the filename should be lowercase kebab-case to match the other docs (wordpress-release-integration.md).

@@ -0,0 +1,38 @@
With each WordPress release cycle, various versions of Gutenberg are included. This has created confusion over time as people try to figure out how best to debug problems and report bugs appropriately. To make this easier for everyone to keep track of, this document serves as a canonical list of the Gutenberg versions present in each WordPress release.

Copy link
Contributor

@talldan talldan Jul 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may also be good to note that each WordPress release also includes bug fixes from later Gutenberg releases that occur during the beta period. It's a little tricky to describe in non-technical terms, maybe something like:

"During the beta period, additional bug fixes from later Gutenberg releases than those noted are cherry-picked into the WordPress release"

It makes me wonder if we should include a very brief overview of how the beta process works, as the above sentence maybe doesn't make much sense in isolation 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added that phrasing in. As for an overview of the beta process, I'm conflicting as that should probably belong on other pages 🤔

@annezazu
Copy link
Contributor Author

annezazu commented Jul 8, 2020

I knew I was messing something obvious up :) I'll take care of this all tomorrow. Thanks, as always, for reviewing @talldan.

@talldan talldan removed the [Type] Enhancement A suggestion for improvement. label Jul 8, 2020
@talldan
Copy link
Contributor

talldan commented Jul 8, 2020

Just removing the Enhancement label as I think the idea at the moment is for PRs to only include one [Type] label to help compiling changelogs.

@mkaz
Copy link
Member

mkaz commented Jul 8, 2020

For reference, documentation for contributing documentation is here, ideally any questions would be answered there. If not, let me know and I can help answer and update.

This is looking good! 👍

Personally, I would just have the last Gutenberg version, so for WP 5.5 it would just say GB 8.5, since each version builds on the previous, thus by default it contains all previous versions. However, I don't feel that strongly about it and if it seems more clear to others I'm fine with how it is.

We'll need to add it to toc.json and then run npm run docs:build I can help with both, or if you want to give it a shot let me know either way. You can be a guinea pig for the testing the contributing documentation. 😄

@annezazu
Copy link
Contributor Author

annezazu commented Jul 9, 2020

I think this is now ready for a final review!

Personally, I would just have the last Gutenberg version, so for WP 5.5 it would just say GB 8.5, since each version builds on the previous, thus by default it contains all previous versions. However, I don't feel that strongly about it and if it seems more clear to others I'm fine with how it is.

Let's launch with how it is for now. Personally, I think showing the different Gutenberg versions in a release even in a condensed way more clearly shows just how much is being added in with each WordPress release.

We'll need to add it to toc.json and then run npm run docs:build I can help with both, or if you want to give it a shot let me know either way. You can be a guinea pig for the testing the contributing documentation. 😄

After wrestling with this and with awesome help from you (thank you), I think I was able to do this! As for documentation, I mainly ran into an issue needing to update npm and node first which feels like more of an edge case than needs to be in the docs.

Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @annezazu 👍
This has been a much requested and will be quite useful for referring to.

@mkaz mkaz merged commit b010251 into master Jul 9, 2020
@mkaz mkaz deleted the annezazu-gutenberg-versions branch July 9, 2020 21:00
@github-actions github-actions bot added this to the Gutenberg 8.6 milestone Jul 9, 2020
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.

Doc: Add Gutenberg plugin version number integrated into WP releases.
3 participants