diff --git a/website/content/en/status/README b/website/content/en/status/README index e9576469fe..9dd3c4589a 100644 --- a/website/content/en/status/README +++ b/website/content/en/status/README @@ -1,168 +1,168 @@ ompiling 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 - The months of January, April, July and October are dedicated to putting together the reports submitted during the precedent month. This can include waiting for late submissions. - portmgr@ entries default to the extended headline, because of the overlap between quarterly reports and quarterly ports branches. - All entries can have the deadline extended by emailing quarterly-submissions@ up until the extended deadline. - Quarterly status report publication is done during the same months as soon as the report is ready. - First Quarter: - First call for reports: March 1st - 2 weeks left reminder: March 15th - Last reminder: March 24th - Standard deadline: March 31st - Extended deadline: April 8th - Second Quarter: - First call for reports: June 1st - 2 weeks left reminder: June 15th - Last reminder: June 24th - Standard deadline: June 30th - Extended deadline: July 8th - Third Quarter: - First call for reports: September 1st - 2 weeks left reminder: September 15th - Last reminder: September 24th - Standard deadline: September 30th - Extended deadline: October 8th - Fourth Quarter: - First call for reports: December 1st - 2 weeks left reminder: December 15th - Last reminder: December 24th - Standard deadline: December 31st - Extended deadline: January 8th 1) Call for reports - Send calls 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 of members of the FreeBSD community that attended it; - Google Summer of Code students and their mentors: soc-students@ and soc-mentors@ (Second and Third Quarter). - 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 'Daniel Ebdrup Jensen' 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 cronjob, 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/ - The Markdown template is at: - https://www.freebsd.org/news/status/report-sample.md + https://www.freebsd.org/news/status/report-sample.adoc - 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. It also helps to forward all the completed reports to developers for reference, and point to the latest report in the CFR. 2) Building the report: - Review and merge pull requests as well as those submitted via email, as they come in. - For each newly merged report, add its filename to the local Makefile: put it in the variable corresponding to the section where you want the report to appear. Sort the variables content as you want to sort the reports in the corresponding section. - While the reports are being updated, other doc-committers (wblock, pluknet, and bjk, for example) may review the individual entries and propose fixes. - Write an introduction in a file named intro.md in the quarterly directory. It should be usually the last step in the process; a good introduction can be only written once all the reports have been collected. - theraven may be poked for composing a nice introduction for the reports. 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 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 use manual editing 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, run "make", and review the generated HTML file, en_US.ISO8859-1/htdocs/news/status/report-XXXX-YY-XXXX-ZZ.html. This step requires that you have installed textproc/docproj on your system. - Adjust the Markdown source and regenerate until you are happy with the result. - Some special characters still break with that - noticed when sos@ submits a report. 3) Committing it: - Files to edit and commit: The quarterly report itself: doc/website/content/en/status/report-yyyy-mm-yyyy-mm.xml Update the next due date on the status report page and add a link to the new report below that: doc/website/content/en/status/_index.adoc The news entry for the main website page: doc/website/data/en/news/news.toml Sample for the news entry (may need to add month): [[news]] date = "2021-01-16" title = "October-December 2020 Status Report" description = "The October to December 2020 Status Report is now available with 42 entries." - After the html version of the report has been built and is online, run in the quarter directory "make all-txt" and prettify its output. This step requires that you have installed www/lynx and lang/perl5.30 (or newer) on your system. lynx defaults to a width of 80 and will forcibly wrap URLs to fit within that size. The prettification process includes undoing that wrapping of URLS, which is made easier by some questions that are asked of you during "make all-txt". In some cases lynx will refuse to output certain Unicode characters (such as the U+0142 LATIN SMALL LETTER L WITH STROKE found in trasz's surname), instead using an ASCII transliteration; these should be returned to the UTF-8 form. - Send out To: announce@ Subject: FreeBSD Quarterly Status Report - Quarter This one must be approved, so find someone (mail postmaster) who can do that before starting. Send a separate mail: To: hackers CC: current, stable BCC: developers 4) Repeat. diff --git a/website/content/en/status/_index.adoc b/website/content/en/status/_index.adoc index 2b9ac58309..d7ed76a673 100644 --- a/website/content/en/status/_index.adoc +++ b/website/content/en/status/_index.adoc @@ -1,162 +1,162 @@ --- title: "FreeBSD Status Reports" sidenav: about --- = FreeBSD Status Reports == Next Quarterly Status Report submissions (January - March) due: March 31st, 2021 -Submit your entries as Pull Requests from your fork of https://github.com/freebsd/freebsd-quarterly[FreeBSD Quarterly Status Reports GitHub repo] or submit them via e-mail to quarterly-submissions@FreeBSD.org, using the link:https://github.com/freebsd/freebsd-quarterly/blob/master/report-sample.md[Markdown template]. +Submit your entries as Pull Requests from your fork of link:https://github.com/freebsd/freebsd-quarterly[FreeBSD Status Report GitHub repo] or submit them via e-mail to quarterly-submissions@FreeBSD.org, using the link:https://github.com/freebsd/freebsd-quarterly/blob/master/report-sample.adoc[report-sample.adoc template]. ''''' One of the benefits of the FreeBSD development model is a focus on centralized design and implementation, in which the operating system is maintained in a central repository, and discussed on centrally maintained lists. This allows for a high level of coordination between authors of various components of the system, and allows policies to be enforced over the entire system, covering issues ranging from architecture to style. However, as the FreeBSD developer community has grown, and the rate of both mailing list traffic and tree modifications has increased, making it difficult even for the most dedicated developer to remain on top of all the work going on in the tree. The FreeBSD Development Status Report attempts to address this problem by providing a vehicle that allows developers to make the broader community aware of their on-going work on FreeBSD, both in and out of the central source repository. For each project and sub-project, a one paragraph summary is included, indicating progress since the last summary. If it is a new project, or if a project has not submitted any prior status reports, a short description may precede the status information. For more exact guidelines on how to write good status reports, please consult link:howto/[our recommendations]. Periodically, special status reports are prepared and published. One of those are the developer summit reports. Developer summits are places where developers meet in person to discuss issues related to the project. They are definitely worth attending if one is interested in making significant contributions to the Project and they are open to anybody! These status reports may be reproduced in whole or in part, as long as the source is clearly identified and appropriate credit given. == 2020 * link:report-2020-10-2020-12/[October, 2020 - December, 2020] * link:report-2020-07-2020-09/[July, 2020 - September, 2020] * link:report-2020-04-2020-06/[April, 2020 - June, 2020] * link:report-2020-01-2020-03/[January, 2020 - March, 2020] == 2019 * link:report-2019-10-2019-12/[October, 2019 - December, 2019] * link:report-2019-07-2019-09/[July, 2019 - September, 2019] * link:report-2019-04-2019-06/[April, 2019 - June, 2019] * link:report-2019-01-2019-03/[January, 2019 - March, 2019] == 2018 * link:report-2018-09-2018-12/[October, 2018 - December, 2018] * link:report-2018-01-2018-09/[October, 2017 - September, 2018] == 2017 * link:report-2017-07-2017-09/[July, 2017 - September, 2017] * link:report-2017-04-2017-06/[April, 2017 - June, 2017] * link:report-2017-01-2017-03/[January, 2017 - March, 2017] == 2016 * link:report-2016-10-2016-12/[October, 2016 - December, 2016] * link:report-2016-07-2016-09/[July, 2016 - September, 2016] * link:report-2016-04-2016-06/[April, 2016 - June, 2016] * link:report-2016-01-2016-03/[January, 2016 - March, 2016] == 2015 * link:report-2015-10-2015-12/[October, 2015 - December, 2015] * link:report-2015-07-2015-09/[July, 2015 - September, 2015] * link:report-2015-04-2015-06/[April, 2015 - June, 2015] * link:report-2015-01-2015-03/[January, 2015 - March, 2015] == 2014 * link:report-2014-10-2014-12/[October, 2014 - December, 2014] * link:report-2014-07-2014-09/[July, 2014 - September, 2014] * link:report-2014-04-2014-06/[April, 2014 - June, 2014] * link:report-2014-01-2014-03/[January, 2014 - March, 2014] == 2013 * link:report-2013-10-2013-12/[October, 2013 - December, 2013] * link:report-2013-09-devsummit/[EuroBSDcon 2013 Developer Summit Special] * link:report-2013-07-2013-09/[July, 2013 - September, 2013] * link:report-2013-04-2013-06/[April, 2013 - June, 2013] * link:report-2013-05-devsummit/[BSDCan 2013 Developer Summit Special] * link:report-2013-01-2013-03/[January, 2013 - March, 2013] == 2012 * link:report-2012-10-2012-12/[October, 2012 - December, 2012] * link:report-2012-07-2012-09/[July, 2012 - September, 2012] * link:report-2012-04-2012-06/[April, 2012 - June, 2012] * link:report-2012-01-2012-03/[January, 2012 - March, 2012] == 2011 * link:report-2011-10-2011-12/[October, 2011 - December, 2011] * link:report-2011-07-2011-09/[July, 2011 - September, 2011] * link:report-2011-04-2011-06/[April, 2011 - June, 2011] * link:report-2011-01-2011-03/[January, 2011 - March, 2011] == 2010 * link:report-2010-10-2010-12/[October, 2010 - December, 2010] * link:report-2010-07-2010-09/[July, 2010 - September, 2010] * link:report-2010-04-2010-06/[April, 2010 - June, 2010] * link:report-2010-01-2010-03/[January, 2010 - March, 2010] == 2009 * link:report-2009-10-2009-12/[October, 2009 - December, 2009] * link:report-2009-04-2009-09/[April, 2009 - September, 2009] * link:report-2009-01-2009-03/[January, 2009 - March, 2009] == 2008 * link:report-2008-10-2008-12/[October, 2008 - December, 2008] * link:report-2008-07-2008-09/[July, 2008 - September, 2008] * link:report-2008-04-2008-06/[April, 2008 - June, 2008] * link:report-2008-01-2008-03/[January, 2008 - March, 2008] == 2007 * link:report-2007-10-2007-12/[October, 2007 - December, 2007] * link:report-2007-07-2007-10/[July, 2007 - October, 2007] * link:report-2007-04-2007-06/[April, 2007 - June, 2007] * link:report-2007-01-2007-03/[January, 2007 - March, 2007] == 2006 * link:report-2006-10-2006-12/[October, 2006 - December, 2006] * link:report-2006-06-2006-10/[June, 2006 - October, 2006] * link:report-2006-04-2006-06/[April, 2006 - June, 2006] * link:report-2006-01-2006-03/[January, 2006 - March, 2006] == 2005 * link:report-2005-10-2005-12/[October, 2005 - December, 2005] * link:report-2005-07-2005-10/[July, 2005 - October, 2005] * link:report-2005-03-2005-06/[March, 2005 - June, 2005] * link:report-2005-01-2005-03/[January, 2005 - March, 2005] == 2004 * link:report-2004-07-2004-12/[July, 2004 - December, 2004] * link:report-2004-05-2004-06/[May, 2004 - June, 2004] * link:report-2004-03-2004-04/[March, 2004 - April, 2004] * link:report-2004-01-2004-02/[January, 2004 - February, 2004] == 2003 * link:report-2003-10-2003-12/[October, 2003 - December, 2003] * link:report-2003-03-2003-09/[March, 2003 - September, 2003] * link:report-2003-01-2003-02/[January, 2003 - February, 2003] == 2002 * link:report-2002-11-2002-12/[November, 2002 - December, 2002] * link:report-2002-09-2002-10/[September, 2002 - October, 2002] * link:report-2002-07-2002-08/[July, 2002 - August, 2002] * link:report-2002-05-2002-06/[May, 2002 - June, 2002] * link:report-2002-02-2002-04/[February, 2002 - April, 2002] * link:report-2001-12-2002-01/[December, 2001 - January, 2002] == 2001 * link:report-2001-11/[November, 2001] * link:report-2001-09/[September, 2001] * link:report-2001-08/[August, 2001] * link:report-2001-07/[July, 2001] * link:report-2001-06/[June, 2001] diff --git a/website/content/en/status/report-sample.md b/website/content/en/status/report-sample.md deleted file mode 100644 index 595487a5ad..0000000000 --- a/website/content/en/status/report-sample.md +++ /dev/null @@ -1,30 +0,0 @@ -## Status Report Sample - This Will Become The Title ## - -Contact: Full Name, - -Link: [Link description here](http://www.example.com/project/url) - -Paragraphs are separated with an empty line. Use Markdown -syntax, the same as you use on GitHub. If you don't know -Markdown, just write it as if it was plain text. - -Introduce your work. Do not assume that the person reading -the report knows about your project. - -Show the importance of your work. Status reports are not -just about telling everyone that things were done, they also -need to explain why they were done. - -What has happened since the last report? Let us know what -is new in this area. - -Optionally include the information about the sponsor. - -If help is needed, make this explicit. List tasks, with enough -detail that people know if they are likely to be able to do them, -and invite people to get in contact: - - * First task - * Second task - * Third, if any -