From owner-svn-doc-all@FreeBSD.ORG Wed May 22 05:28:16 2013 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id B181BE6A; Wed, 22 May 2013 05:28:16 +0000 (UTC) (envelope-from pgj@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) by mx1.freebsd.org (Postfix) with ESMTP id 8B835969; Wed, 22 May 2013 05:28:16 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.6/8.14.6) with ESMTP id r4M5SG8S036388; Wed, 22 May 2013 05:28:16 GMT (envelope-from pgj@svn.freebsd.org) Received: (from pgj@localhost) by svn.freebsd.org (8.14.6/8.14.5/Submit) id r4M5SGnY036387; Wed, 22 May 2013 05:28:16 GMT (envelope-from pgj@svn.freebsd.org) Message-Id: <201305220528.r4M5SGnY036387@svn.freebsd.org> From: Gabor Pali Date: Wed, 22 May 2013 05:28:16 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r41706 - head/en_US.ISO8859-1/htdocs/news/status X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 22 May 2013 05:28:16 -0000 Author: pgj Date: Wed May 22 05:28:16 2013 New Revision: 41706 URL: http://svnweb.freebsd.org/changeset/doc/41706 Log: - Improve the preparation procedure for the future quarterly status reports Discussed with: monthly 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 Wed May 22 05:14:38 2013 (r41705) +++ head/en_US.ISO8859-1/htdocs/news/status/README Wed May 22 05:28:16 2013 (r41706) @@ -23,9 +23,9 @@ Compiling status reports - best practice (secretary@asiabsdcon.org) March. Our readers seem to value these reports, so we should try to get them in if at all possible. -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 s without a description are missing +4) Building the report: + - Accumulate the received reports in a single .xml file and use tidy(1) to + get them well-formatted. Usually 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 @@ -43,6 +43,10 @@ Compiling status reports - best practice
  • some item

    • 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 report template: @@ -136,9 +140,10 @@ Report//EN" the html helps. Make sure you have an up-to-date doc tree. 6) Sending it out: - - 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. + - Explicitly mail all the submitters (in BCC:) with the link pointing to + the HTML version of the prepared report so they could check their + 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 next due date in status.xml and link to the new report. - Add a news entry to head/share/xml/news.xml. Template: