Page MenuHomeFreeBSD
Differential D41990

status: 2023Q3: Process visibility changes
ClosedPublic
Actions

Authored by olce on Sep 26 2023, 8:45 PM.
Tags
None
Referenced Files
F137452640: D41990.id127841.diff
Sun, Nov 23, 2:54 PM
Unknown Object (File)
Sun, Nov 23, 2:29 AM
Unknown Object (File)
Fri, Nov 21, 2:33 AM
Unknown Object (File)
Fri, Nov 21, 2:31 AM
Unknown Object (File)
Fri, Nov 21, 2:29 AM
Unknown Object (File)
Fri, Nov 21, 2:25 AM
Unknown Object (File)
Fri, Nov 21, 2:24 AM
Unknown Object (File)
Fri, Nov 21, 2:24 AM
View All Files
Subscribers
carlavilla

Details

Reviewers
salvadore
carlavilla
Group Reviewers
status
Commits
R9:df0a1f705493: Status/2023Q3/process_visibility.adoc: Add report

Diff Detail

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

Event Timeline

olce created this revision.Sep 26 2023, 8:45 PM
Herald added a reviewer: salvadore. · View Herald TranscriptSep 26 2023, 8:45 PM
olce requested review of this revision.Sep 26 2023, 8:45 PM
Harbormaster completed remote builds in B53736: Diff 127841.Sep 26 2023, 8:46 PM
olce added a reviewer: status.Sep 26 2023, 8:46 PM
olce updated this revision to Diff 127842.Sep 26 2023, 8:53 PM

Fix the manual pages references.

Harbormaster completed remote builds in B53737: Diff 127842.Sep 26 2023, 8:53 PM
carlavilla accepted this revision.Sep 26 2023, 8:53 PM
carlavilla added a subscriber: carlavilla.

Nice, thanks for the report

salvadore requested changes to this revision.Sep 28 2023, 8:48 AM

A few small changes and it is ready. Thanks for your report.

website/content/en/status/report-2023-07-2023-09/process_visibility.adoc
5
16

Please do no use contractions.

38

Please use the serial comma.

43
This revision now requires changes to proceed.Sep 28 2023, 8:48 AM
olce updated this revision to Diff 127893.Sep 28 2023, 9:21 AM
olce marked 4 inline comments as done.

Make requested changes.

website/content/en/status/report-2023-07-2023-09/process_visibility.adoc
5

Done.

May I ask why you insist on using an explicit link macro? Are you parsing the report files or it is just for general consistency?

38

I usually don't use serial commas as they introduce what I think is an unnecessary disruption in the sentence flow (the "and" marks both the nearing end of the enumeration and separates the last two elements). But apparently, it seems common in the US and even recommended in a number of official documents. Anyway, not going to argue more about it here.

Done.

Harbormaster completed remote builds in B53751: Diff 127893.Sep 28 2023, 9:22 AM
salvadore accepted this revision.Sep 28 2023, 9:30 AM
salvadore added inline comments.
website/content/en/status/report-2023-07-2023-09/process_visibility.adoc
5

Explicit use of the link macro is necessary because omitting it breaks translations in some languages (I think the ones with non latin alphabets). I do not believe status reports are much translated, if ever, but better safe than sorry.

38

FreeBSD official documentation also recommends the use of serial commas:
https://docs.freebsd.org/en/books/fdp-primer/writing-style/#writing-style-guidelines

This revision is now accepted and ready to land.Sep 28 2023, 9:30 AM
olce updated this revision to Diff 127894.Sep 28 2023, 9:41 AM

Emphasize that most of the reviews were done by FreeBSD Foundation sponsored committers.

This revision now requires review to proceed.Sep 28 2023, 9:41 AM
Harbormaster completed remote builds in B53752: Diff 127894.Sep 28 2023, 9:41 AM
salvadore accepted this revision.Sep 28 2023, 9:52 AM
salvadore added inline comments.
website/content/en/status/report-2023-07-2023-09/process_visibility.adoc
43

Found another missing serial comma, but can be fixed at commit time.

This revision is now accepted and ready to land.Sep 28 2023, 9:52 AM
olce marked an inline comment as done.Sep 28 2023, 10:02 AM

Thanks.

I can send you the patches by email (to apply with git am) or you can pull them directly from https://github.com/OlCe2/freebsd-doc, branch oc-status_reports.

website/content/en/status/report-2023-07-2023-09/process_visibility.adoc
38

I was looking for a book or article on how to write the documentation and couldn't find one with "doc" in its title. I had forgotten about this document. Thanks!

Closed by commit R9:df0a1f705493: Status/2023Q3/process_visibility.adoc: Add report (authored by olce, committed by salvadore). · Explain WhySep 28 2023, 1:28 PM
This revision was automatically updated to reflect the committed changes.
salvadore added a commit: R9:df0a1f705493: Status/2023Q3/process_visibility.adoc: Add report.

Revision Contents
Changeset List

PathSize
website/
content/
en/
status/
report-2023-07-2023-09/
49 lines

Diff 127902

View Options

website/content/en/status/report-2023-07-2023-09/process_visibility.adoc

Loading...