Skip to content

Docs: split "Gutenberg Release Process" page into two #71130

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Sep 9, 2025
Merged

Docs: split "Gutenberg Release Process" page into two #71130

merged 6 commits into from
Sep 9, 2025

Conversation

@t-hamano
Copy link
Contributor

@t-hamano t-hamano commented Aug 8, 2025 •
edited
Loading

What?

This PR will split the following two sections of the "Gutenberg Release Process" page into pages:

Why?

When I led my first Gutenberg plugin release, I read through the documentation and noticed two things:

Only the section "Gutenberg plugin releases" was required for the plugin release, and the section "Packages releases to NPM and WordPress Core updates" was completely irrelevant.

In the handbook, the table of contents is made up of h2 and h3 headings. This makes important sections like "Organizing and Labeling Milestone PRs" difficult to find:

toc

How?

I extracted the two main sections as subpages:

  • Gutenberg Release Process
    • Gutenberg plugin releases
    • Packages releases to NPM and WordPress Core updates

No changes have been made to the content, but each page should serve a purpose as before.

Testing Instructions

Check the following pages:

@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Aug 8, 2025
@t-hamano t-hamano marked this pull request as ready for review August 8, 2025 07:08
@github-actions
Copy link

github-actions bot commented Aug 8, 2025 •
edited
Loading

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: talldan <talldanwp@git.wordpress.org>
Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

talldan
talldan reviewed Aug 8, 2025
View reviewed changes
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.

Looks like a good idea to split this to me. I suggested some changes to the main release README, might be interesting to see what others think.

docs/contributors/code/release/README.md
@@ -0,0 +1,11 @@
# Gutenberg Release Process
Copy link
Contributor

@talldan talldan Aug 8, 2025

Choose a reason for hiding this comment

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

I wonder if this could be treated more like an table of contents/index page that links to the other two pages and maybe has a very brief summary of the different kinds of releases.

@talldan talldan requested review from cbravobernal and ockham August 8, 2025 07:59
@t-hamano
Copy link
Contributor Author

t-hamano commented Aug 8, 2025

@talldan, thanks for the review!

The index page has been updated as follows:

image

Both plugin releases and the publication of packages require the following.

I've included links in this sentence, so this might be considered a table of contents

@cbravobernal
Copy link
Contributor

cbravobernal commented Aug 18, 2025

@talldan, thanks for the review!

The index page has been updated as follows:

image > Both [plugin releases](https://developer.wordpress.org/block-editor/contributors/code/release/plugin-release/) and [the publication of packages](https://developer.wordpress.org/block-editor/contributors/code/release/package-release-and-core-updates/) require the following.

I've included links in this sentence, so this might be considered a table of contents

We could divide it into three sections:

  • Requisites
  • Plugin releases.
  • Publication of packages.

Maybe that way is easier to follow rather than a couple of links in a sentence that may be skipped when reading.

Thanks for the PR!
It's always great to have feedback of new people handling releases. Fresh eyes in these processes are gold!

@t-hamano
Copy link
Contributor Author

t-hamano commented Aug 19, 2025

Maybe that way is easier to follow rather than a couple of links in a sentence that may be skipped when reading.

Makes sense! Updated in 14b2a23

cbravobernal
cbravobernal approved these changes Sep 8, 2025
View reviewed changes
Copy link
Contributor

@cbravobernal cbravobernal left a comment

Choose a reason for hiding this comment

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

Let's land it!

@github-actions
Copy link

github-actions bot commented Sep 9, 2025

Flaky tests detected in 3dd07f8.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/17568278106
📝 Reported issues:

@t-hamano t-hamano merged commit 3018c8b into trunk Sep 9, 2025
67 checks passed
@t-hamano t-hamano deleted the docs-split-gutenberg-releases branch September 9, 2025 06:07
@github-actions github-actions bot added this to the Gutenberg 21.7 milestone Sep 9, 2025
@t-hamano
Copy link
Contributor Author

t-hamano commented Sep 9, 2025

Thanks for the feedback, everyone.

I confirmed that the new pages have been published to the Block Editor Handbook:

If there are any further improvements, I'll submit a new PR.

@Mamaduka
Copy link
Member

Mamaduka commented Sep 9, 2025

Thanks for handling this, @t-hamano!

talldan added a commit that referenced this pull request Sep 10, 2025
@t-hamano @talldan @cbravobernal
Docs: split "Gutenberg Release Process" page into two (#71130)
408e505 
* Docs: split "Gutenberg Release Process" page into two

* revert unintentional deletion

* Improve index page

* Index Page: divide it into three sections

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: talldan <talldanwp@git.wordpress.org>
Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org>
adamsilverstein pushed a commit to adamsilverstein/gutenberg that referenced this pull request Sep 11, 2025
@t-hamano @talldan
@cbravobernal @adamsilverstein
Docs: split "Gutenberg Release Process" page into two (WordPress#71130)
0d88df0 
* Docs: split "Gutenberg Release Process" page into two

* revert unintentional deletion

* Improve index page

* Index Page: divide it into three sections

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: talldan <talldanwp@git.wordpress.org>
Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org>
@cbravobernal
Copy link
Contributor

cbravobernal commented Sep 11, 2025

We need to update the template to create Gutenberg releases issues. All links are not working now 😅

@t-hamano t-hamano mentioned this pull request Sep 11, 2025
Merged
@t-hamano
Copy link
Contributor Author

t-hamano commented Sep 11, 2025

Ah sorry, I submitted #71611 to fix that 😅

@maxschmeling maxschmeling mentioned this pull request Oct 7, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@talldan talldan talldan left review comments

@cbravobernal cbravobernal cbravobernal approved these changes

@ndiego ndiego Awaiting requested review from ndiego

@priethor priethor Awaiting requested review from priethor

@Mamaduka Mamaduka Awaiting requested review from Mamaduka

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@juanmaguitar juanmaguitar Awaiting requested review from juanmaguitar juanmaguitar is a code owner

@fabiankaegy fabiankaegy Awaiting requested review from fabiankaegy fabiankaegy is a code owner

@ockham ockham Awaiting requested review from ockham

Assignees

No one assigned

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 21.7

Development

Successfully merging this pull request may close these issues.

5 participants

@t-hamano @cbravobernal @Mamaduka @talldan