Improve the instructions.

Sponsored by:	DARPA, AFRL
This commit is contained in:
Edward Tomasz Napierala 2019-09-02 14:25:45 +00:00
parent 78698955ff
commit 167c54dd49
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=53359

View file

@ -2,7 +2,8 @@ Compiling status reports - best practices
0) Timeline (relative to submission deadline)
-1 month First call for reports
-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
@ -55,16 +56,22 @@ deadline Follow up on missing reports
if at all possible.
4) Building the report:
- Fold the reports into a work-in-progress draft as they are coming in (see
point 5) for putting the report together). Commit the result and hook the
draft into the build, so you can (almost) immediately provide the
submitters a preview of their entries. This is also a good excuse to do
a acknowledgement on the receipt.
- While the report draft is kept updated, other doc-committers (wblock,
- 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,
pluknet, and bjk, for example) may review the individual entries and
propose fixes.
- Concatenate the reports into a draft, and add categories, such as
"# FreeBSD Team Reports #" or "# Projects #'. Consult md2docbook.py
source for the list of recognized tags
- Use md2docbook.py to convert from the Markdown draft to DocBook:
https://github.com/trasz/md2docbook
https://github.com/trasz/md2docbook. Copy the generated DocBook draft
to en_US.ISO8859-1/htdocs/news/status/report-XXXX-YY-XXXX-ZZ.xml,
add it to the list in en_US.ISO8859-1/htdocs/news/status/Makefile,
run "make", and review the generated HTML file,
en_US.ISO8859-1/htdocs/news/status/report-XXXX-YY-XXXX-ZZ.html.
Adjust the Markdown source and regenerate until you are happy with
the result.
- Tidy up the draft - tidy(1) may be used to get it well-formatted. Usually
<url>s without a description are missing the closing "/>" which is the cause
for most of the errors you will encounter. Sometimes other closing tags are