Page MenuHomeFreeBSD

HW Relnotes: Enable Table of Contents Subsections
ClosedPublic

Authored by concussious.bugzilla_runbox.com on Oct 24 2024, 5:35 AM.
Referenced Files
Unknown Object (File)
Mon, Nov 25, 8:50 AM
Unknown Object (File)
Fri, Nov 22, 12:00 PM
Unknown Object (File)
Fri, Nov 22, 3:01 AM
Unknown Object (File)
Fri, Nov 8, 6:06 AM
Unknown Object (File)
Fri, Nov 8, 3:13 AM
Unknown Object (File)
Nov 2 2024, 11:40 PM
Unknown Object (File)
Oct 29 2024, 11:19 AM
Unknown Object (File)
Oct 28 2024, 5:23 PM

Details

Summary

I think this really helps the page. I only did the template and upcoming releases, but would be willing to do past ones for consistency if that is appropriate.

May I also (I'm thinking separate reviews):

  1. Put the TOC below the introduction?
  2. Remove or add "Architecture Support" to all subsection titles in section 2 for consistency?
  3. Rename 2.2 "32-bit x86 (i686)" for consistency with the other subsection titles (also these do not support i386 or i486.)
  4. Remove 2.3 entirely for consistency.

If this is acceptable, please git commit --author ="Alexander Ziaee <concussious@runbox.com>" so I can demonstrate my activity. Thanks!

Diff Detail

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

Event Timeline

Re your 3, if you change the section title, I would suggest keeping "i386" since it's the name FreeBSD for the architecture itself, minimum processor generations supported regardless, and instead mention which processor generations it supports, or maybe link to the section of the release notes with that info.

Polite ping? I made this commit atomic and scoped tightly so that we can move quickly, to facilitate ease of contribution to the HW relnotes. Is this controversial?

cperciva added a subscriber: bofh.

@bofh Can you look at this and the submitter's other questions? You're in charge of release notes. :-)

Polite ping? I made this commit atomic and scoped tightly so that we can move quickly, to facilitate ease of contribution to the HW relnotes. Is this controversial?

Sorry, been busy with other stuff. Hopefully Moin can handle this and your other release notes changes.

Copy! No problem, thank you for the quick response! I'll tag him in the future.

Oh grandmasters, please accept my humble and respectful ping! Beta 2 just branched. This commit makes the release hw notes are more accessible, so it can be easier for people to notice where to improve them, which they are less inclined to do the further the release progress comes.

This revision is now accepted and ready to land.Tue, Nov 12, 1:55 AM

This is indeed an improvement. On its own the change is non-controversial, so if @bofh does not reply today I will just commit it.

Personally I agree with your point 4, that section no longer serves a purpose and can be removed.

FYI for next time, this change would have been much easier to evaluate if it was uploaded with a screenshot of the affected content (phabricator can embed this in the summary/testing section). I had to build it myself to see the result.

Thank you so much! I will screenshot these in the future.

FYI for next time, this change would have been much easier to evaluate if it was uploaded with a screenshot of the affected content (phabricator can embed this in the summary/testing section). I had to build it myself to see the result.

Yes. Ia also wondered if the website could have the template build as "CURRENT" continuous release notes so we'd have an almost constant view of the expansion and the state of FreeBSD main AS-IS. I know it's unrelated but in worst case this could have been committed to the template and backed out a few hours later.. doceng

Yes. I also wondered if the website could have the template build as "CURRENT" continuous release notes so we'd have an almost constant view of the expansion and the state of FreeBSD main AS-IS.

This would be a major step forward, and probably less stressful than trying to fix this stuff at the end when it finally becomes visible. I would love to learn how to fix these types of problems. Also it would be helpful for new users in our social spaces constantly asking if $foo is fixed in CURRENT.