12.4 release notes: add the (expected) date
AbandonedPublic
Actions

Authored by grahamperrin on Nov 29 2022, 12:26 AM.

Details

Reviewers

None

Group Reviewers

releng

Summary

Generally: it is fairly commonplace for release notes to include the date of release.

FreeBSD release notes (traditionally): without a date, the reader can step away then find the information elsewhere (maybe https://www.freebsd.org/security/#sup, or an announcement, or the schedule).

Consider including the release date in this set of notes, and in future sets.

Test Plan

Preview in GitHub:

https://github.com/grahamperrin/freebsd-doc/blob/12-4-relnotes-date/website/content/en/releases/12.4R/relnotes.adoc

– branch 12-4-relnotes-date in my fork.

Diff Detail

Repository

R9 FreeBSD doc repository

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

grahamperrin requested review of this revision.Nov 29 2022, 12:26 AM

grahamperrin created this revision.

grahamperrin edited the test plan for this revision. (Show Details)Nov 29 2022, 12:36 AM

grahamperrin added inline comments.Nov 29 2022, 12:44 AM

website/content/en/releases/12.4R/relnotes.adoc
19	5 or 5th? To me (British English), 5th seems more natural. https://docs.freebsd.org/en/books/fdp-primer/writing-style/#writing-style-guidelines suggests American English for spelling, I don't know whether this encompasses dates. Neither do I know whether 5th December 2022 would look weird to an American. Alternatively, 2022-12-05, although I reckon that longhand will look better in this context.

zlei added a subscriber: zlei.Nov 29 2022, 2:59 AM

zlei added inline comments.

website/content/en/releases/12.4R/relnotes.adoc
19	Recent history release note use date format `December 7, 2021`, see [1] and [2] Both `5 December 2022` and `December 5, 2022` look good to me, but I'd prefer the latter for consistence. [1] https://www.freebsd.org/releases/13.1R/announce/ [2] https://www.freebsd.org/releases/12.3R/announce/

grahamperrin marked an inline comment as done.Nov 29 2022, 7:36 AM

grahamperrin added inline comments.

website/content/en/releases/12.4R/relnotes.adoc
19	Interesting, thanks. I chose date (number) before month for consistency, because I'm more familiar with this order at pages such as these: https://www.freebsd.org/news/newsflash/ https://www.freebsd.org/security/#sup https://www.freebsd.org/releases/12.3R/schedule/ https://www.freebsd.org/releases/12.4R/schedule/ https://www.freebsd.org/releases/13.1R/schedule/. I guess, we should change the order, for consistency with the other date, which is already within the page: https://www.freebsd.org/releases/12.4R/relnotes/.