Page MenuHomeFreeBSD

relnotes: fix-up some section oddities
ClosedPublic

Authored by mhorne on Apr 8 2021, 3:33 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Nov 13, 11:10 PM
Unknown Object (File)
Sep 24 2024, 8:59 AM
Unknown Object (File)
Sep 22 2024, 7:45 PM
Unknown Object (File)
Sep 21 2024, 7:39 PM
Unknown Object (File)
Sep 21 2024, 7:39 PM
Unknown Object (File)
Sep 21 2024, 7:39 PM
Unknown Object (File)
Sep 21 2024, 7:31 PM
Unknown Object (File)
Sep 10 2024, 3:36 PM
Subscribers
None

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

mhorne requested review of this revision.Apr 8 2021, 3:33 PM
mhorne created this revision.
This revision is now accepted and ready to land.Apr 8 2021, 3:50 PM
This revision was automatically updated to reflect the committed changes.
website/content/en/releases/13.0R/relnotes.adoc
351

I almost wonder if we don't want to drop this and the General Network instead. It's kind of redundant to just have one subsection that covers all the content.

website/content/en/releases/13.0R/relnotes.adoc
351

12.0 release notes have the "Networked Storage" and "ZF"` sections and I was wondering if we should try to maintain that. If not, removing these sub-headings would make sense.

website/content/en/releases/13.0R/relnotes.adoc
351

I have no opinion either way. Originally, it was added to try to break out the release notes into sections that "made sense." However, when there are not many items to document for either, it would be consolidated into another section if it made sense. So, the sections themselves are not necessarily intended to dictate what/where things should be documented, but more of a template "as things make sense."

If that makes sense...

website/content/en/releases/13.0R/relnotes.adoc
351

One additional note on why "General Networking" existed - non-intuitively, there was intended to be a "Network Drivers" section (and one for at least one of the recent releases), but that kind of fell apart because some stuff ended up in the "Device Drivers" (or "Deprecated Device Drivers") section.

At the time I reorganized the release notes page, it kind of made sense to me to do that, but I am not convinced that stands any longer.

website/content/en/releases/13.0R/relnotes.adoc
351

Right, the sections are a result of their contents, so to speak.

My only concern about removing the e.g. General Storage subheading is that the section description will be immediately followed by the similarly formatted entries, and this isn't consistent with the rest of the document. I feel like we could go back and forth on these minor things though.

I'll also note that in its current state, there are still some issues wrt empty sections.