svn commit: r41126 - head/en_US.ISO8859-1/htdocs/news/status

Isabell Long issyl0 at FreeBSD.org
Thu Mar 7 21:20:42 UTC 2013


Author: issyl0
Date: Thu Mar  7 21:20:41 2013
New Revision: 41126
URL: http://svnweb.freebsd.org/changeset/doc/41126

Log:
  Refresh the status report README to reflect the recent report production
  process.
  
  Hat:	monthly
  Reviewed by:	pgj

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	Thu Mar  7 18:36:50 2013	(r41125)
+++ head/en_US.ISO8859-1/htdocs/news/status/README	Thu Mar  7 21:20:41 2013	(r41126)
@@ -25,7 +25,7 @@ Compiling status reports - best practice
 
 4) Putting it all together:
   - Copy and paste all reports in a single .xml file and use tidy(1) to get
-    it well formatted.  Usually <url>'s without a description are missing
+    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
@@ -44,7 +44,7 @@ Compiling status reports - best practice
       </ul>
       <p>Some more blabla ...
 
-5) After the a couple 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:
 
 <?xml version="1.0" encoding="iso-8859-1" ?>
@@ -136,14 +136,11 @@ Report//EN"
    the html helps.  Make sure you have an up-to-date doc tree.
 
 6) Sending it out:
-  - Just prior to committing, build the html locally.
-  - Extract a text version: lynx -dump -nolist report.html > report.txt
-  - Prettify.
-  - Send out To: hackers, CC: current, stable.  New email to: announce@ this
-    one needs to be approved.  Find somebody who can do that before you
-    start.
-  - Commit.  Also update the next due date in status.sgml and link to the
-    new report.
+  - Commit, hooking the report XML to the build but not linking to it
+    from anywhere.  This gives time for other committers to review and
+    suggest minor changes.
+  - After a few days, collate and commit the changes.  Also update the
+    next due date in status.xml and link to the new report.
   - Add a news entry to head/share/xml/news.xml.  Template:
 	 <event>
 	   <title>June-October, 2006 Status Report</title>
@@ -152,5 +149,10 @@ Report//EN"
              href="&enbase;/news/status/report-2006-06-2006-10.html">now
 	     available</a> with 49 entries.</p>
         </event>
+  - Extract a text version with the command
+    lynx -dump -nolist report.html > report.txt and prettify it.
+  - Send out To: hackers, CC: current, stable.  New email to: announce at .
+    This needs to be approved, so find someone who can do that before you
+    start.
 
 7) Repeat.


More information about the svn-doc-all mailing list