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

Update the Gutenberg release process documentation #52955

Merged
merged 3 commits into from
Jul 27, 2023

Conversation

ndiego
Copy link
Member

@ndiego ndiego commented Jul 25, 2023

What?

This PR updates the Gutenberg release documentation to make sure it is up-to-date with current processes and workflows.

This PR supersedes #50922. Props to @bph for starting that PR and collaborating on the changes in this PR.

Why?

The Gutenberg release docs were out of date and not in line with our current processes.

Note that this PR only focuses on updating the Gutenberg plugin release information. The rest of the doc is largely unchanged and will likely need further updates in follow-up PRs. Also, this is a living document, and we expect further changes will need to be made in the future. This is merely a start.

@ndiego ndiego added the [Type] Developer Documentation Documentation for developers label Jul 25, 2023
@ndiego ndiego requested a review from bph July 25, 2023 22:53
@ndiego ndiego self-assigned this Jul 25, 2023
@ndiego ndiego changed the title Add changelog and update the Gutenberg plugin releases section. Update the Gutenberg release process documentation Jul 25, 2023
@ndiego ndiego marked this pull request as ready for review July 25, 2023 22:56
Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

Fantastic job, both! At last, bringing some clarity to a documentation that currently makes the release look more complex and scary than it actually is. ❤️

In that regard, what do you think about adding a TL;DR; in a follow-up? I worry folks get discouraged from handling releases by seeing a long documentation and getting the wrong impression. 🤔

docs/contributors/code/release.md Outdated Show resolved Hide resolved
Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

The updated version with callouts looks even better; let's merge it! 🚀

@ndiego ndiego merged commit 092fd0b into trunk Jul 27, 2023
50 checks passed
@ndiego ndiego deleted the update/gutenberg-release-docs branch July 27, 2023 13:44
@github-actions github-actions bot added this to the Gutenberg 16.4 milestone Jul 27, 2023
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.

2 participants