Bug 27041 - Split release notes into two documents, 'Technical release notes' and 'End user release notes'
Summary: Split release notes into two documents, 'Technical release notes' and 'End us...
Status: CLOSED WONTFIX
Alias: None
Product: Project Infrastructure
Classification: Unclassified
Component: Release tools (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low enhancement
Assignee: Jonathan Druart
QA Contact:
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-11-17 09:45 UTC by Martin Renvoize
Modified: 2022-12-12 21:24 UTC (History)
7 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Renvoize 2020-11-17 09:45:46 UTC
Discussion on bug 22890 has diverged a bit away from the inclusion of a chronological changelog to how we format and highlights bugs in our release notes.

We discussed adding bugzilla keywords to allow highlighting certain bugs, but I also wonder about somehow slimming down our end-user notes and instead splitting the notes into two with a technical change focused notes and a less technical notes highlighted by a new 'technical' keyword?
Comment 1 Martin Renvoize 2020-11-17 09:56:01 UTC
I'm happy to take on adding this to the release tools if people are interested in such a change
Comment 2 Jonathan Druart 2020-11-17 10:20:17 UTC
I think it's good to have everything listed at the same place. I like the way we did for 20.05, with a dedicated section for the technical stuffs.

However we should maybe highlight a bit more what important (actually we already have the notes for that).
Comment 3 Andrew Fuerste-Henry 2020-11-17 13:00:43 UTC
I'm torn on this. When we go through the release notes to prepare to upgrade our partners there are always one or two bugs that get listed as "Architecture, internals, and plumbing" but have really profound end-user implications. I'd worry that further splitting the notes would make those things even easier to miss.
Comment 4 Martin Renvoize 2020-11-17 13:03:57 UTC
Perhaps some bugs warrant inclusion in both sets... I'm just trying to work out how we can better highlight the 'interesting' bits to the various parties without having to distract them by all the less interesting bits.

I already tried to improve some of those important points by adding in semi-standardised notes for features that include new sysprefs, changes to reports and updated configs and script flags... though could really do with some help getting those in place for the next release.. it ended up a bit of a one man task the last couple of cycles.