Page MenuHomeFreeBSD

Alternative formatting on freebsd/developer/* blocks
ClosedPublic

Authored by khng on Mar 16 2021, 11:43 AM.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

khng requested review of this revision.Mar 16 2021, 11:43 AM
khng created this revision.

Good catch!

Approved by: philip (mentor)

This revision is now accepted and ready to land.Mar 16 2021, 11:49 AM
lwhsu added a reviewer: docs.
debdrup added a subscriber: debdrup.

Once you've tested that it looks good, with make -C /usr/doc/documentation (run|build), you're welcome to go ahead and commit this. :)

khng retitled this revision from Restore _index.adoc formatting to the intended one to Use double underscore than breaking up freebsd/developer.Mar 16 2021, 4:01 PM

Revised the old rendering

This revision now requires review to proceed.Mar 16 2021, 4:02 PM
khng retitled this revision from Use double underscore than breaking up freebsd/developer to Simplify formatting and use underscores in freebsd/developer blocks.Mar 16 2021, 4:34 PM
This revision is now accepted and ready to land.Mar 16 2021, 5:04 PM

I would also suggest adding a link to https://wiki.freebsd.org/IRC/Cloaks, as that explains the requirements, et cetera.

documentation/content/en/articles/committers-guide/_index.adoc
3252–3253

This would align it with how manual pages denote mandatory fields.
I believe it's also used elsewhere in the FreeBSD documentation (although examples escape me right now).

khng retitled this revision from Simplify formatting and use underscores in freebsd/developer blocks to Alternative formatting on freebsd/developer/* blocks.Mar 16 2021, 6:05 PM

Alternative formatting on freebsd/developer/* blocks

Suggested by debdrup

This revision now requires review to proceed.Mar 16 2021, 6:06 PM
khng marked an inline comment as done.Mar 16 2021, 6:06 PM
This revision is now accepted and ready to land.Mar 17 2021, 1:13 AM