From owner-svn-doc-all@freebsd.org Tue Jun 9 11:23:35 2020 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 AD4B6329987; Tue, 9 Jun 2020 11:23:35 +0000 (UTC) (envelope-from salvadore@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) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 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 49h76H4DVCz4Lxv; Tue, 9 Jun 2020 11:23:35 +0000 (UTC) (envelope-from salvadore@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 8C7BA14F92; Tue, 9 Jun 2020 11:23:35 +0000 (UTC) (envelope-from salvadore@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id 059BNZkE009723; Tue, 9 Jun 2020 11:23:35 GMT (envelope-from salvadore@FreeBSD.org) Received: (from salvadore@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id 059BNZmi009722; Tue, 9 Jun 2020 11:23:35 GMT (envelope-from salvadore@FreeBSD.org) Message-Id: <202006091123.059BNZmi009722@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: salvadore set sender to salvadore@FreeBSD.org using -f From: Lorenzo Salvadore Date: Tue, 9 Jun 2020 11:23:35 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r54222 - head/en_US.ISO8859-1/htdocs/news/status X-SVN-Group: doc-head X-SVN-Commit-Author: salvadore X-SVN-Commit-Paths: head/en_US.ISO8859-1/htdocs/news/status X-SVN-Commit-Revision: 54222 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.33 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: Tue, 09 Jun 2020 11:23:35 -0000 Author: salvadore (ports committer) Date: Tue Jun 9 11:23:35 2020 New Revision: 54222 URL: https://svnweb.freebsd.org/changeset/doc/54222 Log: htdocs/news/status: Update README Update README with information about the mailing list freebsd-quarterly-calls@ and the sendcalls perl script. Also warn about the md2docbook perl script becoming obsolete once the Hugo/AsciiiDoctor conversion is done. Reviewed by: debdrup Approved by: docs (bcr), gerald (mentor) Differential Revision: https://reviews.freebsd.org/D25193 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 Tue Jun 9 10:49:25 2020 (r54221) +++ head/en_US.ISO8859-1/htdocs/news/status/README Tue Jun 9 11:23:35 2020 (r54222) @@ -1,5 +1,11 @@ Compiling status reports - best practices +Quarterly status reports git repository: +https://github.com/freebsd/freebsd-quarterly + +E-mail address for report submissions: +quarterly-submissions@FreeBSD.org + 0) Timeline - First Quarter: @@ -41,33 +47,30 @@ Compiling status reports - best practices it is ready. 1) Call for 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, and folks who have submitted something for the - previous report, in case the project was continued: a list of e-mail - addresses for those folks can be generated by entering in the directory of - the git repository containing reports for last quarter and typing - "make extract-contacts". - - The following groups should be definitely approached for a report on - their recent activities: - - core@, portmgr@, doceng@, secteam@, re@, postmaster@, clusteradm@, - devsummit@ (team reports). - - FreeBSD Foundation (emaste@), participants of Foundation-sponsored - projects, deb@ (Deb Goodkin) can also do a report for the Foundation - itself. - - Various conference organizers, depending on the season: - - AsiaBSDCon (secretary@asiabsdcon.org) March (First Quarter) - - BSDCan (info@bsdcan.org) May (Second Quarter) + - Send reports to the freebsd-quarterly-calls@ mailing list, to all submitters + of last quarterly status reports (they may have updates or further + improvements), and, depending on the season: + - Various conference organizers: + - AsiaBSDCon (secretary@asiabsdcon.org) March (First Quarter); + - BSDCan (info@bsdcan.org) May (Second Quarter); - EuroBSDcon September - October (Third-Fourth Quarter). EuroBSDcon as an organization is not interested in writing reports for FreeBSD (at least it was not in October 2019: its reason is that the conference is not FreeBSD specific), so reports about this event should be - asked to members of the FreeBSD community that attended to it. + asked to members of the FreeBSD community that attended to it; - Google Summer of Code students and their mentors: soc-students@ and soc-mentors@ (Second and Third Quarter). - - All submitters for the previous quarterly status report (they may have - updates or further improvements). + - The easiest way to send calls for quarterly status reports is to use the + sendcalls perl script in the tools directory of the git repository. It + can also be used through a cron job, for example: + + 0 0 1,15,24 3,6,9,12 * cd ~/freebsd-quarterly/tools && ./sendcalls -s 'Lorenzo Salvadore' + + If you are indeed using a cron job, please run it on freefall and sign it + with your name so that it is possible to infer who has configured the cron + job, in case something goes wrong. + The script automatically sends calls to freebsd-quarterly-calls@, last + quarter submitters and other recipients depending on the season. - It may also be worth making a call for reports on the forums as was done here: https://forums.freebsd.org/threads/call-for-freebsd-2014q4-october-december-status-reports.49812/ @@ -96,8 +99,11 @@ Compiling status reports - best practices wblock suggests that we ask different people to write introductions to add variety. Different people will bring different viewpoints and help keep it fresh. - - Run "make" or "make all-xml" in the quarter directory. This step needs that - you have lang/python37 (or other python3 version) installed on your system. + - Run "make" or "make all-xml" in the quarter directory. This step needs perl + as it invokes the md2docbook perl script. Warning: md2docbook lacks some + features and likely has some bugs. Do not waste your time working on it and + prefer manual solutions instead: once the conversion of the FreeBSD website + to Hugo/AsciiDoctor is finished the md2docbook script will become obsolete. - 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, @@ -106,25 +112,8 @@ Compiling status reports - best practices This step needs that you have installed textproc/docproj on your system. - 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 - missing. - - Invoking tidy with the following options seems to cause the fewest - problems: tidy -xml -i -wrap 74 -latin1 -preserve - Some special characters still break with that - noticed when sos@ submits a report. - - Remove empty "" sections, they cause a strange looking - newline. - - The part usually needs a hand to make it proper html. Use here, not . - - Lists come out best if you close the

before and start a new one - after, like: - ... blabla:

-
    -
  • some item
    • -
-

Some more blabla ... 3) Committing it: