The Notable Changes in a release announcement are based on git commit log. A recommend practice for git commit messages is:
“Use the imperative mood.”
For example:
Disabledracut
module resume in VMs since it might break the boot process if built insidechroot
. https://gitlab.com/whonix/vm-config-dist/-/commit/ee07d87be47c3c48f4369b5816876d5d826999a4
This then gets rewritten in (Stable Release: Difference between revisions - Whonix) on Stable Release - Whonix to:
- Disabled
dracut
module resume in VMs since it might break the boot process if built insidechroot
. https://gitlab.com/whonix/vm-config-dist/-/commit/ee07d87be47c3c48f4369b5816876d5d826999a4
Which might be more appropriate for the wiki. Should I ignore that git commit messages best practices part and try change my habits to use “descriptive mood” instead of “imperative mood”?
I am wondering if some effort on @torjunkie’s side for maintaining Stable Release - Whonix could be lowered.
Maybe Notable Changes
could be left out in release announcements by me.
- To avoid duplication.
Notable Changes
would then be auto generated in mediawiki markup instead of markdown makeup (forums). I could post them in the wiki instead. (Maybe with a comment if still in testing and not actually stable yet or wiki pending moderation as long as not in stable yet.)
Then there would be no need to copy/paste (and duplicate) them from forums to wiki. And fixes on top of my writeups would still be very much welcome.
Also if it seems useful… Feel free to edit my forum posts with the usual very much appreciated enhancements that are happening in the wiki all the time all over the place.
Other suggestions to simplify the changelog writing process?