Page MenuHomeFreeBSD

Update FAQ 2.2 with current doc layout and formats.
ClosedPublic

Authored by pauamma_gundo.com on Oct 13 2022, 3:00 AM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Apr 19, 11:40 AM
Unknown Object (File)
Jan 19 2024, 10:35 PM
Unknown Object (File)
Jan 12 2024, 2:19 PM
Unknown Object (File)
Dec 22 2023, 6:13 AM
Unknown Object (File)
Dec 20 2023, 3:01 AM
Unknown Object (File)
Nov 15 2023, 8:32 PM
Unknown Object (File)
Nov 7 2023, 12:15 PM
Unknown Object (File)
Nov 1 2023, 4:02 PM
Subscribers

Details

Test Plan

make all and eyeball with lynx

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 47852
Build 44739: arc lint + arc unit

Event Timeline

pauamma_gundo.com created this revision.

I'm not at all sure I've got the file formats part right. This is derived from observation. Anyone who knows the nuts and bolts of what is generated, please review and correct me if/where/as needed.

documentation/content/en/books/faq/_index.adoc
276

language, singular.

276

?

356–357
pauamma_gundo.com marked an inline comment as done.

Graham Perrin's comments and a few I forgot earlier.

That's probably enough, for now, Phabricator makes my head spin …

documentation/content/en/books/faq/_index.adoc
263
266
268–270

It might have been FTP in the past, but now it's HTTPS, and (I think) in this case, let's not be shy about making the address visible.

272–273
275
276
347

Let's remind ourselves that the page is (or should be) – essentially – answers to questions about FreeBSD.

That's probably enough, for now, Phabricator makes my head spin …

That's OK. (I have a similar problem with Github.) I'm shelving this until doc slush ends anyway.

documentation/content/en/books/faq/_index.adoc
276

Replaced "these" with its new referent.

276

?

Not sure what that 2nd comment is asking.

documentation/content/en/books/faq/_index.adoc
263

Focusing on the layout question in this review.

268–270

Agreed about not mentioning FTP, not about the URL alone as link text. (On second thought, I don't agree with the original either, for accessibility.)

276

Going to keep the original wording, paralleling "The document's name" above.

347

Will revisit later, along with the rest of the tersifying you suggested.

Changes following grahamperrin's review.

This revision is now accepted and ready to land.Oct 31 2022, 11:13 AM