Details

Reviewers

karels
emaste
carlavilla

Group Reviewers

manpages

Commits

R9:db2db2d6bade: 14.0 relnotes: some additions

Summary

I did a pass of the current release notes, fixing some very minor issues
I saw and adding things I know to be missing, some of it being my own
work.

The biggest part of the change is introduction of a new "Documentation"
section to describe man page changes.

Sorry that it is squashed together, I can commit certain parts
separately if need be.

Diff Detail

Repository

R9 FreeBSD doc repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

mhorne requested review of this revision.Nov 7 2023, 7:22 PM

mhorne created this revision.

Harbormaster completed remote builds in B54321: Diff 129834.Nov 7 2023, 7:22 PM

carlavilla added a subscriber: carlavilla.Nov 7 2023, 7:24 PM

carlavilla added inline comments.

website/content/en/releases/14.0R/relnotes.adoc
753	Maybe a link to hardware will be better, no?

One other thing I noticed, "Sponsored by" lines are rendered as regular text; in some previous release notes they used the {{< sponsored "Sponsor" >}} macro. It renders these lines differently, giving a visual hint which IMO makes the information on this page easier to parse.

See for example, the 13.0 release notes: https://www.freebsd.org/releases/13.0R/relnotes/

website/content/en/releases/14.0R/relnotes.adoc
486–489	I wasn't sure where to put this in the section. I really suggest a separate sub-section for deprecated/removed drivers.

emaste accepted this revision.Nov 7 2023, 7:40 PM

emaste added inline comments.

website/content/en/releases/14.0R/relnotes.adoc
486–489	Yeah, makes sense -- could follow up with another review to do that.

This revision is now accepted and ready to land.Nov 7 2023, 7:40 PM

Include a link to the hardware page as well.

This revision now requires review to proceed.Nov 7 2023, 7:47 PM

Harbormaster completed remote builds in B54322: Diff 129835.Nov 7 2023, 7:47 PM

mhorne marked an inline comment as done.Nov 7 2023, 7:48 PM

mhorne added inline comments.

website/content/en/releases/14.0R/relnotes.adoc
753	FYI `{u-rel140-hardware} doesn't expand properly yet.

In D42496#969749, @mhorne wrote:

One other thing I noticed, "Sponsored by" lines are rendered as regular text; in some previous release notes they used the {{< sponsored "Sponsor" >}} macro. It renders these lines differently, giving a visual hint which IMO makes the information on this page easier to parse.

See for example, the 13.0 release notes: https://www.freebsd.org/releases/13.0R/relnotes/

The overall formatting has changed since then, and the example entries since 13.1 have used the current format. @carlavilla, any comments on this?

website/content/en/releases/14.0R/relnotes.adoc
272	I'm not sure this is accurate with "the" added. It implies that only this revision is 1st edition, which I don't think is true.
273	I think this change is wrong; the entire sentence is inside the parens.
753	It looks like you can put the full URL there instead.
772	I think this reads better without the commas. (And I usually want more commas.)
782	I think this section should follow the format used elsewhere, a paragraph per entry rather than a bullet list.

Ufff, don’t use this shortcode, I need to remove it.
I made that in the migration but is useless.

You can accomplish something similar with _word_
It’s true the macro put the font in small size but it’s most difficult to write it. With _word_ is more simple IMHO

mhorne added inline comments.Nov 7 2023, 8:34 PM

website/content/en/releases/14.0R/relnotes.adoc
273	Sure, I can drop these, other than the spacing fix at the start. It merely seemed wrong to me.
782	Sure, if you like. They thinking was that they all fall under one umbrella item.