Details
- Reviewers
carlavilla grahamperrin - Group Reviewers
status - Commits
- R9:4e47e73e9f94: Add 2022Q4 status report
Diff Detail
- Repository
- R9 FreeBSD doc repository
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
status: To make the last review easier, here you can find the list of the commits I have added since the last revision:
https://github.com/freebsd/freebsd-quarterly/compare/ef6df68...cb8b687
This review is focused on the release of the latest status report. After we are done with it, I will submit other reviews to go forward with our workflow improvement project, e.g. I will propose changes to website/content/en/status/_index.adoc about reports submissions.
website/content/en/status/report-2022-10-2022-12/_index.adoc | ||
---|---|---|
3 | ||
website/content/en/status/report-2022-10-2022-12/accessibility.adoc | ||
2 | Can we ignore these white space peculiarities, if they don't affect layout? A screenshot of the highlighted characters: {F55239423} | |
website/content/en/status/report-2022-10-2022-12/budgie.adoc | ||
16 | ||
website/content/en/status/report-2022-10-2022-12/cheribsd.adoc | ||
28 | An earlier paragrpah does americanise this word, so maybe ignore the non-americanised title of what's linked. Americanise this word? Or de-americanise compartmentalization in the earlier paragraph? | |
website/content/en/status/report-2022-10-2022-12/clusteradm.adoc | ||
75 | Either a full … specification (singular) or full … specifications (plural). | |
website/content/en/status/report-2022-10-2022-12/doceng.adoc | ||
10 | https://www.freebsd.org/internal/doceng/ does not use the phrase Document Engineering, would you prefer the team to be formally/consistently known as the Doceng Team? | |
17 | Not consistent with what's above. FWIW, I prefer Document Engineering Team. | |
website/content/en/status/report-2022-10-2022-12/freebsd-foundation.adoc | ||
29–31 | ||
website/content/en/status/report-2022-10-2022-12/papers.adoc | ||
4–5 | Consistency with the current sample document/template. | |
website/content/en/status/report-2022-10-2022-12/portsdb.adoc | ||
25 | ||
website/content/en/status/report-2022-10-2022-12/pot.adoc | ||
26 | ||
28 | ||
website/content/en/status/report-2022-10-2022-12/pytest-for-atf.adoc | ||
16 | ||
website/content/en/status/report-2022-10-2022-12/riscv.adoc | ||
8–10 | ||
website/content/en/status/report-2022-10-2022-12/status.adoc | ||
48 | Would you like to mention this (but not describe it) in _index.adoc? | |
50 | ||
website/content/en/status/report-2022-10-2022-12/xen.adoc | ||
27 | ||
website/content/en/status/report-2022-10-2022-12/xfce.adoc | ||
8–9 |
Thanks @grahamperrin. I have added some inline comments and I am going to fix the review.
website/content/en/status/_index.adoc | ||
---|---|---|
8 | We are indeed removing "quarterly" from the team name, but we are also still publishling reports on a quarterly basis, so I think we can keep it here. Moreover, if we removed "Quarterly" here, it might be less clear what "(January - March)" refers to. | |
10 | I plan to change this line later since more edits will be needed anyway (i.e. we will need to change the GitHub repository for pull requests and add the possibility of submitting reports through Phabicator). However, the email address can indeed be already changed. | |
website/content/en/status/report-2022-10-2022-12/_index.adoc | ||
3 | I agree: there is no need for the "Quarterly" word here since we also have "Quarter" later. | |
website/content/en/status/report-2022-10-2022-12/accessibility.adoc | ||
2 | No, I think it is better to fix those spaces: the only occurence that I had found and corrected was giving a false positive in our testing tools. | |
website/content/en/status/report-2022-10-2022-12/cheribsd.adoc | ||
28 | The FreeBSD Documentation Primer has a recommendation for American spelling here: https://docs.freebsd.org/en/books/fdp-primer/writing-style/#writing-style-guidelines . It might be argued that status reports fall into the exception of contributed articles, but even in that case consistency is still required. So I am going to use the American spelling here. | |
website/content/en/status/report-2022-10-2022-12/doceng.adoc | ||
10 | The report has been submitted by the team itself, written as it is. I believe it is the team's reponsibility to decide how it wants to be called. So I prefer to leave it as it is. | |
17 | I see Doceng as an abbreviation for Documentation Engineering, so I consider it to be consistent: the report author has chosen to use the full name in the title and the abbreviation in the Contact field, but the name itself is the same in both cases. | |
website/content/en/status/report-2022-10-2022-12/papers.adoc | ||
4–5 | I had noticed this thing when I created the review, but ignored it. However, on second thought, consistency is always a good thing. I think I had found a few other occurences of this issue: I am going to fix those as well. | |
website/content/en/status/report-2022-10-2022-12/status.adoc | ||
48 | Yes, but I will deal with this later. Now the month is coming to an end so I prefer to focus on the publication of the latest status report. |
Here is the review corrected.
Corresponding commits on GitHub: https://github.com/freebsd/freebsd-quarterly/compare/cb8b687...94489ef .
Neither of these suggested changes is essential.
Thanks, everyone.
website/content/en/status/report-2022-10-2022-12/releng.adoc | ||
---|---|---|
11 | Consistency with other submissions, and with the sample/template. | |
website/content/en/status/report-2022-10-2022-12/status.adoc | ||
50–51 | Italicised (my previous change) does suit formatted delivery, however I did not think ahead to the plain text email delivery. '…' maybe better. |
I have fixed both reports. Relevant GitHub commit: https://github.com/freebsd/freebsd-quarterly/commit/affe3f5e275e69c88495d2daabff7105a24c1c09