Date: Tue, 27 Nov 2018 11:54:27 +0000 (UTC) From: Edward Tomasz Napierala <trasz@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52519 - head/en_US.ISO8859-1/htdocs/news/status Message-ID: <201811271154.wARBsRKM086029@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: trasz Date: Tue Nov 27 11:54:26 2018 New Revision: 52519 URL: https://svnweb.freebsd.org/changeset/doc/52519 Log: Update Status Reports HOWTO. Reviewed by: bcr Approved by: bcr (mentor) Differential Revision: https://reviews.freebsd.org/D18306 Modified: head/en_US.ISO8859-1/htdocs/news/status/README Modified: head/en_US.ISO8859-1/htdocs/news/status/README ============================================================================== --- head/en_US.ISO8859-1/htdocs/news/status/README Mon Nov 26 16:08:45 2018 (r52518) +++ head/en_US.ISO8859-1/htdocs/news/status/README Tue Nov 27 11:54:26 2018 (r52519) @@ -16,12 +16,10 @@ deadline Follow up on missing reports - Are usually sent to freebsd-hackers@ CC freebsd-current@ as the lists with the most usual suspects for submitting reports. Forward to developers@ as well. Also ping individuals which are known to have - something cooking. - - The xml-template is at: - https://www.freebsd.org/news/status/report-sample.xml at the time of this - writing. Make sure to keep it up to date with regard to categories - to pick from and place them prominently in the CFR - otherwise people - submit plain text reports and you have to format them yourself. + something cooking, and folks who have submitted something for the + previous report, in case the project was continued. + - 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. It contains a great deal of useful hints for the submitters on how to write good reports. But it also helps to forward all the completed @@ -65,10 +63,11 @@ deadline Follow up on missing reports - While the report draft is kept updated, other doc-committers (wblock, pluknet, and bjk, for example) may review the individual entries and propose fixes. - - As mentioned above, the received reports should be in a single .xml file, - where tidy(1) may be used to 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 encounter. Sometimes other closing tags are + - Use md2docbook.py to convert from the Markdown draft to DocBook: + https://github.com/trasz/md2docbook + - 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 missing. - Invoking tidy with the following options seems to cause the fewest problems: tidy -xml -i -wrap 74 -latin1 -preserve
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201811271154.wARBsRKM086029>