ziglang / www.ziglang.org

https://ziglang.org/
MIT License
261 stars 157 forks source link

Display the release date on each release notes page #149

Open roryokane opened 2 years ago

roryokane commented 2 years ago

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:

release notes without date

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:

release notes with date in heading next to version number

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

nektro commented 2 years ago

That info is available here https://github.com/ziglang/zig/releases

It is bad practice to tie a release to a date.