For the past couple of releases, we’ve been looking for a better way to write and publish the release notes. We made some improvements last cycle, for GNOME 41, with the move to Gitlab pages for publishing. However, we have continued to use Mallard and associated tooling. Now it’s time to write the release notes for GNOME 42, and I would personally really like it if we could complete the transition to a new setup.
The main requirements for the release notes are:
- Should look good
- Require minimal maintenance
- Ability to embed images and video
- Easy to contribute to
In the past, we’ve looked for a solution which has also been compatible with our translations software. However, despite trying, we haven’t had much success. The solutions we’ve looked at just haven’t had good translations support. We’ve also realised that our own support for translations hasn’t been very good in the past. In particular, we’ve historically lacked a way to show the correct language on the website, or a way to switch between languages.
We’ve therefore got to the point of considering a solution which doesn’t support translations, but which meets our other requirements. You can see the result in a new test site which @jimmac has put together. It’s nice and simple, looks good, supports embedding multimedia, has content which is written in Markdown, and is published using Gitlab pages. In short, I think it fulfills all our requirements.
If anyone has any suggestions or ideas for alternatives, it would be great to hear them. Otherwise, I think that this looks like a good solution for the GNOME 42 release notes.