From owner-svn-doc-all@freebsd.org Mon Sep 2 14:25:46 2019 Return-Path: Delivered-To: svn-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 9B780DF624; Mon, 2 Sep 2019 14:25:46 +0000 (UTC) (envelope-from trasz@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 46MXSB3YlBz3KTn; Mon, 2 Sep 2019 14:25:46 +0000 (UTC) (envelope-from trasz@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 43BDE1B604; Mon, 2 Sep 2019 14:25:46 +0000 (UTC) (envelope-from trasz@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id x82EPkYa096340; Mon, 2 Sep 2019 14:25:46 GMT (envelope-from trasz@FreeBSD.org) Received: (from trasz@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id x82EPkLl096339; Mon, 2 Sep 2019 14:25:46 GMT (envelope-from trasz@FreeBSD.org) Message-Id: <201909021425.x82EPkLl096339@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: trasz set sender to trasz@FreeBSD.org using -f From: Edward Tomasz Napierala Date: Mon, 2 Sep 2019 14:25:46 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r53359 - head/en_US.ISO8859-1/htdocs/news/status X-SVN-Group: doc-head X-SVN-Commit-Author: trasz X-SVN-Commit-Paths: head/en_US.ISO8859-1/htdocs/news/status X-SVN-Commit-Revision: 53359 X-SVN-Commit-Repository: doc 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.29 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: Mon, 02 Sep 2019 14:25:46 -0000 Author: trasz Date: Mon Sep 2 14:25:45 2019 New Revision: 53359 URL: https://svnweb.freebsd.org/changeset/doc/53359 Log: Improve the instructions. Sponsored by: DARPA, AFRL 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 Sep 2 00:25:13 2019 (r53358) +++ head/en_US.ISO8859-1/htdocs/news/status/README Mon Sep 2 14:25:45 2019 (r53359) @@ -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 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