#223 New release notes structure
Closed a month ago by pbokoc. Opened 5 years ago by pbokoc.

(Originally tracked in https://pagure.io/release-notes/issue/26)

The current structure of our release notes doesn't really work; we have a bunch of sections that are never used (Printing!) and at the same time, many things we write about don't really map very well to any of these sections.

At the same time, Fedora Project has a lot of Special Interest Groups (SIGs), as listed here: https://fedoraproject.org/wiki/Category:SIGs

Basing our relnotes structure on these groups would:

1) Make the release notes mirror the community much better

2) Give us an easy way to contact people and search for changes; right now we mostly depend on ChangeSets for each release, but with this structure we could easily just e-mail each SIG and ask them what changed in their area. Then, ideally, most if not all would respond, and we could compile their info into actual release notes.

We probably won't be doing this for F25, but it's something I think we should look at for future releases, especially if we're planning to do other big changes at the same time.

Additional comment from @immanetize:

I started mapping this kind of structure a while ago, in the form of a guide to writing relnotes, at https://fedoraproject.org/wiki/User:Immanetize/Beats_Redux . This might give us a good starting place.


My one concern with basing release notes on our project structure is that this may not represent what hte users want to do. What if we had the release notes structured as a final step. There isn't, afaik (right now on Sunday Morning) a need for the ToC to be the same from Release to Release.

Metadata Update from @pbokoc:
- Issue status updated to: Closed (was: Open)

a month ago

Login to comment on this ticket.

Metadata