Status: 2023q3: doceng: corrections, markup #271
Conversation
This quarter, not last. Add missing markup, for list items. Compare with https://www.freebsd.org/status/report-2023-01-2023-03/#_documentation_engineering_team Real names for people who requested safekeeping of their commit bits. Compare with the same past report. Include the resignation of my doc commit bit. Express this in the same way as the safekeeping of Sergey Kandaurov's doc commit bit.
There was a problem hiding this comment.
Approved if someone in doceng also approves. @sergio-carlavilla? @dbaio?
|
No, I prefer the report sent by fernape@ |
|
Ok, then this pull request can be closed. @grahamperrin: Please note that your commit bit resignation was already added with commit 1687289. |
Continue from freebsd#271 (comment) The new Weblate server was a server, not a person (should not be amongst the list of humans who perform translation). Moreover: the Weblate server was new in April (last quarter, not this quarter). So, don't repeat the news. Fix URLs. Uppercase USES (not Uses), and no need to repeat the word 'New'. Markup: remove unnecessary white space before list items. Some punctuation. Another discrepancy should become clearer, in GitHub, following these changes. Fixes: aed40a9 Status/2023Q3/doceng.adoc: Add report Pull-request: freebsd#271
A visual comparison might help. Please note, use of bullet points:
The current edition of this quarter's report lacks the bullet points:
|
|
If you reopen this PR, for things that remain to be fixed, will it automatically begin to work with my second commit to the I wonder. |
|
No, keep it as it. |
Do you mean, keep the broken links and other issues? |
|
Maybe I misunderstood. @sergio-carlavilla do you mean, keep this pull request closed (keep it as is) and make a new pull request? The GitHub view of the current edition 7bf022d should be reasonably clear, clear enough to see some of what remains to be fixed. If not clear in GitHub, this PDF might help: |
Fix the markup, in my previous commit, for the two USES list items. In the USES context, remove white spaces. Consistent with https://docs.freebsd.org/en/books/porters-handbook/book/ the FreeBSD Porter's Handbook, which never exemplifies 'USES ='. Consistency: Americanise headings. Some were already Americanised. Where a heading is followed by a single sentence that ends with a colon: remove the trailing colon from the heading.
|
Go ahead, I'm gonna reopen the PR |
'Three new translators' was followed by a list of four. Assume that the list is true, fix the number.
'four phases:' was followed by a list of three. Assume that three is true. Correct the number.
There was a problem hiding this comment.
Please see the two most recent commit messages.
Re: the discrepancies, are my assumptions true?
In particular, I don't know about the people who translate; whether all four of them were truly new specifically in the third quarter.
(Bear in mind, the duplicated news about the Weblate server, which might have been a copy-and-paste error from a past report.)
|
@lsalvadore make the commit please. |
Reviewed by: carlavilla (doceng) Pull Request: #271
|
Commit done, thanks. |
Reviewed by: carlavilla (doceng) Pull Request: freebsd#271
Reviewed by: carlavilla (doceng) Pull Request: freebsd#271
Chronology: this quarter, not last. This quarter is the third.
Markup:
--for em dashes, where appropriateReal names for people who requested safekeeping of their commit bits – compare with the same past report
Include the resignation of my doc commit bit. Express this in the same way as the safekeeping of Sergey Kandaurov's doc commit bit.✅ Done.The new Weblate server was a server, not a person (should not be amongst the list of humans who perform translation).
Moreover: the Weblate server was new in April (last quarter, not this quarter). So, don't repeat the news.
Fix five URLs:
urlappends to URLs in the past, I wonder whether they're the result of something that's automated or scripted.Miscounts:
Uppercase
USESfor technical accuracy (notUses), exemplifyUSES=…for consistency with all instances within the relevant handbook (notUSES =…with an additional white space), and no need to repeat the word 'New'.Consistency:
Punctuation: