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

Make release dates more recognizeable on the Download (Releases) page #150

Closed
roryokane opened this issue Sep 12, 2021 · 2 comments
Closed

Comments

@roryokane
Copy link

roryokane commented Sep 12, 2021

Problem

I had been curious about release dates when browsing Zig’s website before, but hadn’t found them. Though I mainly looked at release notes pages (#149), I also had visited https://ziglang.org/download/ before, and hadn’t noticed the dates on that page. I only found they were on that page when I searched this repo for information about release dates and saw that they were inserted onto this page.

How a release on that page looks:

hard-to-see date on download page

There are three factors making that release date hard to see:

  • All the other items in that list are reference links. Those links are only there to be clicked on; there is no information to be gained by reading their text. When skimming, one might assume the first bullet point is the same.
  • The date has no label. It doesn’t say it’s a release date; that has to be inferred from context.
  • The date blends in with the release version number, which is repeated many times on that page (in every download link).

Ideas for solutions

release date on download page 3 – expanded bullet point “Released on”
release date on download page 2 – date in header as phrase “…, released …”
release date on download page – small date in header “…, (released …)”

I think I prefer the second one. Even the first one would be an improvement, though.

Idea for the future

It also might be nice if “master” labeled the date differently, since it will have many release dates over time. It might call the date “Last released” or “Last updated” instead of “Released”. However, it looks like the code for the downloads page doesn’t output the master release separately:

downloads_release_order = [
"master",
"0.8.1",
"0.8.0",

so let’s leave differentiating “master” for a later step.

Implementation

https://ziglang.org/download/ is generated from this code that displays each release’s date from data/releases.json as a list item:

{{ range $release_name := $.Site.Params.downloads_release_order }}
{{ $release := index $.Site.Data.releases $release_name }}
<h2 id="release-{{$release_name}}">{{$release_name}}</h2>
<ul>
<li>{{ index $release "date" }}</li>

That is the code to change.

In one of my above mockups, CSS would also need to be added somewhere to style a span in the heading to have smaller text: font-size: 0.75em;.

@nektro
Copy link
Contributor

nektro commented Sep 17, 2021

Please see my comment on #149

@kristoff-it
Copy link
Member

Doesn't seem that people care too much about the discoverability of the date, as there was no other mention of this in the last couple of years, leaving things as they are since the information in fact is already pretty accessible even if not highlighted.

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