Skip to content
This repository has been archived by the owner on Mar 1, 2023. It is now read-only.

README.adoc: early preparations for 2022q4 #535

Merged
merged 4 commits into from
Oct 22, 2022

Conversation

grahamperrin
Copy link
Contributor

Whilst here, AsciiDoc tidiness, and more, including:

  • awareness of freebsd-announce
  • attention to order and heading levels
  • clearer presentation of dates.

Note, "immediately after the end of the quarter" will be 1st January 2023 (not the last day of the third month within the quarter).

There's not yet a 2022q4 folder, it'll appear (with a Makefile) in due course.

Whilst here: AsciiDoc tidiness, and more, including: 

* awareness of freebsd-announce
* attention to order and heading levels
* clearer presentation of dates.

"Immediately after the end of the quarter" will be 1st January 2023 (not the last day of the third month within the quarter).
The word 'time' is superfluous. Current time period, current period.
README.adoc Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
The related request for changes: <freebsd#535 (review)>. 

Comments from @lsalvadore answered some underlying questions, which I had not raised, there's now a very clear picture of what is (or should be) routine. This commit: 

* reorders things slightly 
* makes some lines/sentences a little shorter 
* aims to make the numbered steps, for submission, a little easier to digest, at a glance 
* drops a hint to allow edits from maintainers. 

The reorder, in a nutshell: 

1. begin with emphasis on acting early 
2. next, be free from worries (the offer of corrections to drafts) 
3. add a section for reviewing 
3. demote lateness to the end of a section (no longer mixed with the general blurb – lateness should be exceptional, not general).
README.adoc Outdated Show resolved Hide resolved
README.adoc Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
Aim to resolve the conversation with @lsalvadore at <freebsd#535 (comment)>. 

Looking ahead: FreeBSD Status Reports <https://www.freebsd.org/status/> might benefit from some kind of definition of the team. 

For now: revert to a single sentence, not a bullet point, that specifies an e-mail address.
@grahamperrin
Copy link
Contributor Author

@lsalvadore please: was request #535 (review) fulfilled?

grahamperrin added a commit to grahamperrin/freebsd-quarterly that referenced this pull request Oct 22, 2022
Late changes, so feel to reject all suggestions. 

This pull request dovetails with the conversation at <freebsd#535 (review)> about possible methods of contacting the team, or individual members. 

Link to the main FreeBSD Status Reports page, which is not directly available through the current sidebar (it's indirectly through the News link). 

Whilst here: maybe also link to last quarter's report. 

Without something (first) 'on one hand', there should be nothing 'on the other hand'. 

The phrase 'quarterly team' is a little ambiguous. Better: 'status report team' (or 'quarterly status report team') in the sign-off.
@lsalvadore lsalvadore merged commit 05f858a into freebsd:main Oct 22, 2022
@lsalvadore
Copy link
Member

Yes, everything is fine, thanks @grahamperrin.

I am about to try to address issue #324 about merging this repository into the FreeBSD doc repository, which is an important step to improve our workflow (having the reports in this repository for reviewing and in the FreeBSD doc repository for publication is annoying for many reasons). Thus, I would like that this was the last modification to README.adoc before the repository merging (assuming we really do it) and to postpone future changes to the future corresponding file in the doc repository. So if you have any more improvements to suggest for it, wait a bit for them please.

For the same reason, I refrain to create the 2022q4 directory for now. This might be the first quarter for which reports will be merged directly in the doc repository (thus no more commits such as 4b8255e).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants