os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

- Improve the preparation procedure for the future quarterly status reports

Browse source 
Discussed with:	monthly
This commit is contained in:
Gabor Pali 2013-05-22 05:28:16 +00:00
parent 4defeca8a9
commit 6f61fc068c
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=41706
1 changed files with 11 additions and 6 deletions

17
en_US.ISO8859-1/htdocs/news/status/README
View file

@ -23,9 +23,9 @@ Compiling status reports - best practices
(secretary@asiabsdcon.org) March. Our readers seem to value (secretary@asiabsdcon.org) March. Our readers seem to value
these reports, so we should try to get them in if at all possible. these reports, so we should try to get them in if at all possible.
4) Putting it all together: 4) Building the report:
- Copy and paste all reports in a single .xml file and use tidy(1) to get - Accumulate the received reports in a single .xml file and use tidy(1) to
it well formatted. Usually <url>s without a description are missing get them well-formatted. Usually <url>s without a description are missing
the closing "/>" which is the cause for most of the errors you will the closing "/>" which is the cause for most of the errors you will
encounter. Sometimes other closing tags are missing. encounter. Sometimes other closing tags are missing.
- Invoking tidy with the following options seems to cause the fewest - Invoking tidy with the following options seems to cause the fewest
@ -43,6 +43,10 @@ Compiling status reports - best practices
<li>some item</li> <li>some item</li>
</ul> </ul>
<p>Some more blabla ... <p>Some more blabla ...
- Review and commit the reports immediately as they are coming in. Hook the
resulting XML to the build for the first time but do not link to it from
anywhere. This gives time for other committers to review and suggest
minor changes.
5) After a couple of iterations of the above, wrap the whole thing in a 5) After a couple of iterations of the above, wrap the whole thing in a
report template: report template:
@ -136,9 +140,10 @@ Report//EN"
the html helps. Make sure you have an up-to-date doc tree. the html helps. Make sure you have an up-to-date doc tree.
6) Sending it out: 6) Sending it out:
- Commit, hooking the report XML to the build but not linking to it - Explicitly mail all the submitters (in BCC:) with the link pointing to
from anywhere. This gives time for other committers to review and the HTML version of the prepared report so they could check their
suggest minor changes. entries before publication. It is wise to set an exact deadline for
this, in order to avoid late comments.
- After a few days, collate and commit the changes. Also update the - After a few days, collate and commit the changes. Also update the
next due date in status.xml and link to the new report. next due date in status.xml and link to the new report.
- Add a news entry to head/share/xml/news.xml. Template: - Add a news entry to head/share/xml/news.xml. Template: