Plugin release docs: Multiple changes #50922
Conversation
There was a problem hiding this comment.
Thanks, Birgit. Rather than expanding the documentation, we should aim at simplifying it. Currently, it kind of feels overwhelming for first-timers, as it feels like one should read and understand the whole documentation to wrangle a release. In contrast, some of it (e.g., cherry-picking) only needs to be consulted on a need-to-know basis.
For starters, apart from shortening information about the launch process itself (it's just a GitHub action), we should further divide the document into sections and add a Table of Content on top. This can be done in follow-up PRs, though.
| @@ -47,16 +47,51 @@ This message is misleading and no action is required by the release coordinator. | |||
|
|
|||
| As soon as the workflow has finished, you'll find the release draft under [Gutenberg Releases](https://github.com/WordPress/gutenberg/releases). The draft is pre-populated with changelog entries based on previous release candidates for this version and any changes that have since been cherry-picked to the release branch. Thus, when releasing the first stable version of a series, delete any RC version headers (that are only there for your information) and move the more recent changes to the correct section (see below). | |||
|
|
|||
| The changelog draft will be partially pre-organized (based on GitHub labels) into sections and, within those, into “features.” Take some time to read the generated notes and then edit them to ensure legibility and accuracy. | |||
| ## Streamline curating the release changelog. | |||
There was a problem hiding this comment.
I think this section could be split into more digestible, smaller ones.
There was a problem hiding this comment.
I have:
- Review of Milestone Labels
- Curating the changelog markdown.
I will edit it for brevity soon.
|
Flaky tests detected in f54da5d. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5081589052
|
|
@priethor Thanks for reviewing the draft PR. There are things that don't take any effort at all, like the workflow. They still need to be explained and are covered. Some things take a lot of time if want to make the most of the time spent and have a good outcome, like curating the changelog and creating the release post. Now, it would probably be helpful if we create the release documentation following the issue checklist. So each item that needs some explanation, is covered, in the order it's worked on. |
I like that idea! |
|
@ndiego and I are continuing our work on Google Docs for now. |
|
Closed as replaced by #52955 |
Fixes: #50343 #49884 #42516
Why?
Streamline the process, better onboard new contributors and update on the process.