Update Quarterly's README:

- Make timeline clearer.

- Remove section 2): its content is now clearly included in section 0)
  just after the timeline.

- Merge section 1) and section 3) and sort their elements more
  consistently.

- Remove inexistent e-mail address for EuroBSDcon and explain that reports
  about it should be asked to people that went to it and not to the
  organization itself.

Submitted by:	salvadore@
Differential Revision:	https://reviews.freebsd.org/D22558
This commit is contained in:
Edward Tomasz Napierala 2019-12-02 13:17:30 +00:00
parent cfa8a4d8cb
commit 8dcfa0a0c0
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=53647

View file

@ -1,17 +1,32 @@
Compiling status reports - best practices
0) Timeline (relative to submission deadline)
0) Timeline
-1 month First call for reports - that will be January 1st, April 1st,
July 1st, and October 1st
-2 weeks Reminder
-1 week Reminder, and follow up with teams and individuals we expect to
submit reports
deadline Follow up on missing reports
Continue editing individual reports
Continue adding new (late) reports as they arrive
+1 week Edit overall report and write introduction
+10 days Publish report
- First Quarter:
- First call for reports: March 1st
- 2 weeks left reminder: March 15th
- Last reminder: March 24th
- Second Quarter:
- First call for reports: June 1st
- 2 weeks left reminder: June 15th
- Last reminder: June 24th
- Third Quarter:
- First call for reports: September 1st
- 2 weeks left reminder: September 15th
- Last reminder: September 24th
- Fourth Quarter:
- First call for reports: December 1st
- 2 weeks left reminder: December 15th
- Last reminder: December 24th
The months of January, April, July and October are dedicated to put together
the reports submitted during the precedent months. This can include waiting
for late submissions.
Quarterly status report publication is done during the same months as soon as
it is ready.
1) Call for reports
- Are usually sent to freebsd-hackers@ CC freebsd-current@ as the lists
@ -19,6 +34,28 @@ deadline Follow up on missing reports
developers@ as well. Also ping individuals which are known to have
something cooking, and folks who have submitted something for the
previous report, in case the project was continued.
- The following groups should be definitely approached for a report on
their recent activities:
- core@, portmgr@, doceng@, secteam@, re@, postmaster@, clusteradm@,
devsummit@ (team reports).
- FreeBSD Foundation (emaste@), participants of Foundation-sponsored
projects, deb@ (Deb Goodkin) can also do a report for the Foundation
itself.
- Various conference organizers, depending on the season:
- AsiaBSDCon (secretary@asiabsdcon.org) March (First Quarter)
- BSDCan (info@bsdcan.org) May (Second Quarter)
- EuroBSDcon September - October (Third-Fourth Quarter).
EuroBSDcon as an organization is not interested in writing reports for
FreeBSD (at least it was not in October 2019: its reason is that the
conference is not FreeBSD specific), so reports about this event should be
asked to members of the FreeBSD community that attended to it.
- Google Summer of Code students and their mentors: soc-students@ and
soc-mentors@ (Second and Third Quarter).
- All submitters for the previous quarterly status report (they may have
updates or further improvements).
- It may also be worth making a call for reports on the forums as was
done here:
https://forums.freebsd.org/threads/call-for-freebsd-2014q4-october-december-status-reports.49812/
- The Markdown template is at:
https://www.freebsd.org/news/status/report-sample.md
- Reporting howto is at: https://www.freebsd.org/news/status/howto.html.
@ -26,36 +63,8 @@ deadline Follow up on missing reports
to write good reports. But it also helps to forward all the completed
reports to developers for reference, and point to the latest report
in the CFR.
- It may also be worth making a call for reports on the forums as was
done here:
https://forums.freebsd.org/threads/call-for-freebsd-2014q4-october-december-status-reports.49812/
2) In the past we usually had to extend the deadline by a week in order to
get everybody to report. Starting early with kind reminders seems to
help ;) Ideally, reminders should be sent at least one month before the
deadline. But it is worthwhile the keep sending reminders two weeks
before the deadline and on the day of the deadline.
3) The following groups should be definitely approached for a report on
their recent activities:
- core@, portmgr@, doceng@, secteam@, re@, postmaster@, clusteradm@,
devsummit@ (team reports).
- FreeBSD Foundation (emaste@), participants of Foundation-sponsored
projects, deb@ (Deb Goodkin) can also do a report for the Foundation
itself.
- Various conference organizers, depending on the season:
- BSDCan (info@bsdcan.org) May (April-June)
- EuroBSDcon (foundation@eurobsdcon.org) Sept-Oct (October-December)
- AsiaBSDCon (secretary@asiabsdcon.org) March (January-March)
- Google Summer of Code students and their mentors (soc-students@ and
soc-mentors@, April-June, July-September).
- All submitters for the previous quarterly status report (they may have
updates or further improvements).
Our readers seem to value these reports, so we should try to get them in
if at all possible.
4) Building the report:
2) Building the report:
- Review and merge pull requests as they are coming in
- Review and merge reports submitted via email
- While the reports are being updated, other doc-committers (wblock,
@ -92,7 +101,7 @@ deadline Follow up on missing reports
</ul>
<p>Some more blabla ...
5) Wrapping the whole thing in a report template:
3) Wrapping the whole thing in a report template:
- Use a filename of yyyy-mm-yyyy-mm.xml for the new report, where the
first mm is the starting month and the second mm is the ending
@ -119,7 +128,7 @@ deadline Follow up on missing reports
add variety. Different people will bring different viewpoints and help
keep it fresh.
6) Committing it:
4) Committing it:
- Files to edit and commit:
@ -180,4 +189,4 @@ deadline Follow up on missing reports
CC: current, stable
BCC: developers
7) Repeat.
5) Repeat.