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

script/update-docs: use ISO-8601 dates for history #1979

Merged
merged 2 commits into from
Mar 14, 2025

Conversation

To1ne
Copy link
Contributor

@To1ne To1ne commented Mar 14, 2025

Changes

The script script/update-git-version.rb already uses ISO-8601 dates,
which are less confusing for most people.

Update script/update-docs.rb to use ISO-8601 date format too.

Context

image

@To1ne
Copy link
Contributor Author

To1ne commented Mar 14, 2025

I know I'm pretty biased, and it's one of my pet peeves. But because we use ISO dates already for the release, I hope this change isn't really controversial:

image

In my opinion are less confusing for everyone. Having a fully qualified year is just better.

@To1ne
Copy link
Contributor Author

To1ne commented Mar 14, 2025

@dscho You're also on this side of the pond, so should we ask someone on the other side to review these changes?

@dscho
Copy link
Member

dscho commented Mar 14, 2025

should we ask someone on the other side to review these changes?

@To1ne By "someone on the other side", do you refer to people living in the country that puts month before day before year when they write out dates? Sure 😆

Having said that, I don't expect anyone from that part of the world to review any git-scm.com PR any time soon, I haven't seen much in the way of contributions to this site from that country; I guess they are too busy coping with current events than having fun with Hugo and stuff, and who can fault them for that.

Copy link
Member

@dscho dscho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes a lot of sense. Here is a map of our wonderful planet, where the pink parts refer to places that use the current date format which this PR aims to replace:

world map of date time formats; pink is "month-day-year"

While there is a lot of blue there (referring to "day-month-year"), changing to that format would be only confusing to readers who previously had to parse "month/day/year", yet "year-month-date" is still easy to understand in those parts of the world.

As is easy to see, the vast, vast majority of people would have an easier time with the format proposed in this PR. Therefore I am all in favor of this change!

date: 12/17/14
date: '2014-12-17'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope that you did not do this by hand but instead let the script do its job...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Darn it, I should have realized that this is affected by the v2.49.0 update.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am letting the workflow redo it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I force-pushed the result.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged it into my own fork's gh-pages and deployed it, you can see it in action e.g. here

image

To1ne and others added 2 commits March 14, 2025 20:49
The script script/update-git-version.rb already uses ISO-8601 dates,
which are less confusing for most people.

Update script/update-docs.rb to use ISO-8601 date format too.

Signed-off-by: Toon Claes <[email protected]>
Updated via the `update-git-version-and-manual-pages.yml` GitHub workflow.
@jasonlong
Copy link
Member

My American brain still struggles with this, but I think it's the correct thing to do (and what we do at PlanetScale fwiw).

@dscho
Copy link
Member

dscho commented Mar 14, 2025

My American brain still struggles with this, but I think it's the correct thing to do (and what we do at PlanetScale fwiw).

Thank you!

@dscho dscho merged commit 6540655 into git:gh-pages Mar 14, 2025
1 check passed
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

Successfully merging this pull request may close these issues.

3 participants