Background information
Release notes
- #3409180: 10.3.0-alpha1 release notes
- #3409181: 10.3.0-beta1 release notes
- #3409182: 10.3.0-rc1 release notes
- 10.3.0 release notes draft gdoc
Instructions
- Read over the 10.3.0 release notes draft. The section at the top is the initial outline for the release notes. The sections at the bottom need to be completed.
- Make sure that all Issues tagged '10.3.0 release notes are included in the release notes.
- Review the format of the release notes, and leave comments on the Google doc where something seems incorrect:
- Ensure that every release note describes a disruptive change. Additions without any disruptive changes belong in the release highlights post, not the release notes.
- Ensure that every release note follows the release note snippet best practices.
- Ensure that every release note (save those about a dependency update) includes a link to a change record.
- Ensure that release notes are formatted correctly in bulleted lists, and that each list item has a blank newline between the tag and the list item text. For example:
<li> A disruptive change is described here. For more information, review <a href="">the change record about what-and-such</a>. </li> - Follow the rough organization suggested by committers. If you think something belongs in a different section, leave a comment.
- Use the Google Docs "suggestion" feature to suggest corrections, readability improvements, etc.
- Comment on this issue to receive credit for working on the release notes.
Comments
Comment #3
xjmComment #4
xjmComment #5
xjmComment #7
xjmComment #8
xjmOops, wrong issue.
Comment #10
xjmComment #12
xjmI updated the draft based on the Drupal 11 beta, the release cycle changes, and the 10.3.0-beta1 and rc1 milestone notes. Also finally fleshed out the IS instructions.
Comment #13
xjmComment #14
smustgrave commentedThere’s currently 1 issues in RTBC. It’s merged but release note needed some work and gave it a shot
Comment #15
smustgrave commentedI'm assuming this is actually postponed
#3441010: Container compile crash when a service decorates a destructable service is in the list but is currently NW
#3298701: ImageStyleDownloadController routes do not limit schemes served is merged but release note needs a new review.
Comment #18
xjmComment #19
xjmNo, it is actively being worked on because the release comes out in less than a week. Thanks!
Comment #20
xjmBetter status.
Comment #21
smustgrave commentedShould the issue that’s still in work be removed from 10.3 release notes
Comment #22
neclimdulDon't see it in the gdoc but #144538: User logout is vulnerable to CSRF might be a disruptive change for sites. Had some hard coded /user/logout links in some templates which lead to a pretty ugly unthemed confirmation form.
Comment #23
xjm@smustgrave Which issue and which section? Stuff that is still underway is listed under "known issues" on purpose, but is there an issue outside those sections?
@neclimdul, thanks, I reopened #144538: User logout is vulnerable to CSRF for a release note snippet.
Comment #24
smustgrave commented@xjm sorry I was referring to #3441010: Container compile crash when a service decorates a destructable service
Comment #25
xjm@smustgrave, Yep, that one is listed under the known issues on purpose, because it's a major bug that could cause problems for people updating to 10.3.
Comment #26
xjmAdding credit for @neclimdul; that's a good find.
Comment #27
pameeela commentedEdit: Oops commented on the wrong issue!
Comment #28
nicxvan commentedI tagged two more issues:
#3333401: Pager h4 causes accessibility flag on many pages
#3439439: Remove country setting from the installer
Re reading this issue summary they probably belong in the highlights rather than release notes.
Let me know where they go and I'll retag them.
Comment #29
nicxvan commentedAlso #3333418: Fix pager h4 for accessibility on Stable9 was already tagged, but I don't see it in the release notes.
Comment #30
xjm@nicxvan, correct, only changes that are disruptive should go in the release notes. The release notes should describe the disruption the site owners or module developers need to address and how.
If it's just an improvement or feature, it should be tagged for the highlights instead.
I don't have time at the moment to look over these three issues, but if they are disruptive, then the release notes should be updated to describe what the disruption is, who is affected, and what they need to do to fix it, with a link to the change record. For more information and examples, see the release note snippet documentation.
Leaving NR to check back on them.
Comment #31
nicxvan commentedIn that case the pager ones are likely highlights since they are accessibility improvements (They were split up since one of them was for stable9)
#3333401: Pager h4 causes accessibility flag on many pages
#3333418: Fix pager h4 for accessibility on Stable9
I've retagged those two already.
The country default in the installer is likely disruptive if someone is expecting that default to be set. It was not used in core and low usage in contrib, but likely qualifies for release notes:
#3439439: Remove country setting from the installer
Comment #32
smustgrave commentedWill say about the pager ones though. Even though they aren't disruptive any module that ships with a view config file will need to be updated for future installs right?
Comment #33
pameeela commentedEdit: going to move my comment to the specific issue.
Comment #34
nicxvan commentedAfter reading the comment from @pameeela I don't think the country setting needs a release note.
@smustgrave that is a good point, I think since we added config new config we didn't hit the circular issue @dww hit here: https://www.drupal.org/project/drupal/issues/2640994#comment-15597379 so these probably can stay in highlights unless someone disagrees.
I think my confusion stemmed from this comment asking for a release note: https://www.drupal.org/project/drupal/issues/3333418#comment-14886507
and since that issue was a follow up I assumed the parent needed release notes too, but based on the docs I think they fit better under highlights.
Comment #35
smustgrave commentedWith 10.3.0 out should this be marked fixed?
Comment #36
catchYep we can close this now (still possible to add issues to the release notes now the release it's out if something comes up).
Comment #37
xjmI was leaving it open on purpose to remind myself to look at #28 and #29 once more info was provided.
Comment #39
idebr commentedIt seems that many of the issues tagged with "10.3.0 release highlights" didn't make it to the release notes: https://www.drupal.org/project/issues/search?issue_tags=10.3.0%20release...
Several issues I have ran into in customer projects weren't mentioned, for example:
#2519362: Redesign the menu link add form to be less overwhelming
#3432183: Move system/base component CSS to respective libraries where they exist
#2936995: Add taxonomy term revision UI
Can these highlights be merged into the release notes?
Comment #40
xjmAmending attribution.
Comment #41
quietone commented