Open roryokane opened 2 years ago
Pages like https://ziglang.org/download/0.8.1/release-notes.html and https://ziglang.org/download/0.8.0/release-notes.html don’t display the date of those releases:
That is information I look for on a release notes page.
I think the best place for the release date would be this heading:
https://github.com/ziglang/www.ziglang.org/blob/9de50d6ace53ac93106ced15073daf2c8691a612/src/download/0.8.1/release-notes.html#L219
Making the release notes page look like this:
I haven’t found any template for all release notes files – I only found individual files for each release, such as src/download/0.8.1/release-notes.html and src/download/0.8.0/release-notes.html. So the above heading might have to be edited in each release-notes.html file.
In this codebase, release dates are stored in data/releases.json.
The code to build https://ziglang.org/download/ includes release dates on its page. It gets the date like this:
https://github.com/ziglang/www.ziglang.org/blob/9de50d6ace53ac93106ced15073daf2c8691a612/themes/ziglang-original/layouts/_default/downloads.html#L11-L12
https://github.com/ziglang/www.ziglang.org/blob/9de50d6ace53ac93106ced15073daf2c8691a612/themes/ziglang-original/layouts/_default/downloads.html#L16
That info is available here https://github.com/ziglang/zig/releases
It is bad practice to tie a release to a date.
Problem
Pages like https://ziglang.org/download/0.8.1/release-notes.html and https://ziglang.org/download/0.8.0/release-notes.html don’t display the date of those releases:
That is information I look for on a release notes page.
Proposed solution
I think the best place for the release date would be this heading:
https://github.com/ziglang/www.ziglang.org/blob/9de50d6ace53ac93106ced15073daf2c8691a612/src/download/0.8.1/release-notes.html#L219
Making the release notes page look like this:
I haven’t found any template for all release notes files – I only found individual files for each release, such as src/download/0.8.1/release-notes.html and src/download/0.8.0/release-notes.html. So the above heading might have to be edited in each release-notes.html file.
Related code to reference when implementing
In this codebase, release dates are stored in data/releases.json.
The code to build https://ziglang.org/download/ includes release dates on its page. It gets the date like this:
https://github.com/ziglang/www.ziglang.org/blob/9de50d6ace53ac93106ced15073daf2c8691a612/themes/ziglang-original/layouts/_default/downloads.html#L11-L12
https://github.com/ziglang/www.ziglang.org/blob/9de50d6ace53ac93106ced15073daf2c8691a612/themes/ziglang-original/layouts/_default/downloads.html#L16