Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display the release date on each release notes page #149

Open
roryokane opened this issue Sep 12, 2021 · 3 comments
Open

Display the release date on each release notes page #149

roryokane opened this issue Sep 12, 2021 · 3 comments

Comments

@roryokane
Copy link

roryokane commented Sep 12, 2021

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:

<h1>0.8.1 Release Notes</h1>

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:

{{ range $release_name := $.Site.Params.downloads_release_order }}
{{ $release := index $.Site.Data.releases $release_name }}

@nektro
Copy link
Contributor

nektro commented Sep 17, 2021

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

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

@Atomk
Copy link
Contributor

Atomk commented Sep 20, 2024

@nektro Any evidence supporting that "bad practice" claim? Rust, Go, Python, Swift, even release pages on Github all clearly show the release date.

It's useful information to contextualize the content of the page (i.e. some blog post linked to the 0.11.0 release notes and readers can easily see when that happened), it doesn't make sense to waste readers' time by having them look somewhere else for something this trivial.

For the same reason I am very glad that the News page (and posts finally) have dates too.

@nektro
Copy link
Contributor

nektro commented Sep 20, 2024

i disagree with my previous statement in this context. i might have misunderstood the request at first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants