Date: Wed, 5 May 2021 23:46:39 GMT From: Daniel Ebdrup Jensen <debdrup@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: 2bbfb011a2 - main - status: Announce the January-March 2021 status report Message-ID: <202105052346.145NkdGw054036@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by debdrup: URL: https://cgit.FreeBSD.org/doc/commit/?id=2bbfb011a29eab29b22433490e6e436f5be8898c commit 2bbfb011a29eab29b22433490e6e436f5be8898c Author: Daniel Ebdrup Jensen <debdrup@FreeBSD.org> AuthorDate: 2021-05-05 23:37:44 +0000 Commit: Daniel Ebdrup Jensen <debdrup@FreeBSD.org> CommitDate: 2021-05-05 23:46:27 +0000 status: Announce the January-March 2021 status report Because of a nit that was missed in the planning of the report, the URI generation was not completely in-place when the status report was initially commited, so the official announcement and email had to be delayed a bit. While here, make corrections to the README file, so that they reflect reality. Hat tip to: lwhsu --- website/content/en/status/README | 43 ++++++++++------------------------- website/content/en/status/_index.adoc | 4 ++++ website/data/en/news/news.toml | 5 ++++ 3 files changed, 21 insertions(+), 31 deletions(-) diff --git a/website/content/en/status/README b/website/content/en/status/README index 9dd3c4589a..5012494853 100644 --- a/website/content/en/status/README +++ b/website/content/en/status/README @@ -74,7 +74,7 @@ quarterly-submissions@FreeBSD.org - 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: + - The AsciiDoctor template is at: 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 @@ -101,30 +101,16 @@ quarterly-submissions@FreeBSD.org 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. + - Once all the reports have come in, make any final adjustsments and copy + the contents of the directory to + doc/website/content/en/status/report-yyyy-mm-yyyy-mm/ 3) Committing it: - Files to edit and commit: - The quarterly report itself: - doc/website/content/en/status/report-yyyy-mm-yyyy-mm.xml + The quarterly report itself, found in: + doc/website/content/en/status/report-yyyy-mm-yyyy-mm/ Update the next due date on the status report page and add a link to the new report below that: @@ -140,17 +126,12 @@ quarterly-submissions@FreeBSD.org description = "The <a href=\"https://www.FreeBSD.org/status/report-2020-10-2020-12.html\">October to December 2020 Status Report</a> 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. + use w3m to dump the website as plain-text, something like the following: + w3m -cols 80 -dump https://www.freebsd.org/status/report-2021-01-2021-03/ > /tmp/report-2021-01-2021-03.txt + + w3m has full proper unicode support, and as w3m(1) explains, -dump simply + outputs text rendering of the html that can then have a few elements + snipped, while -cols ensures that everything is wrapped to 80 columns. - Send out To: announce@ diff --git a/website/content/en/status/_index.adoc b/website/content/en/status/_index.adoc index 906bf219fb..e0b295847c 100644 --- a/website/content/en/status/_index.adoc +++ b/website/content/en/status/_index.adoc @@ -21,6 +21,10 @@ Periodically, special status reports are prepared and published. One of those ar These status reports may be reproduced in whole or in part, as long as the source is clearly identified and appropriate credit given. +== 2021 + +* link:report-2021-01-2021-03/[January, 2021 - March, 2021] + == 2020 * link:report-2020-10-2020-12/[October, 2020 - December, 2020] diff --git a/website/data/en/news/news.toml b/website/data/en/news/news.toml index 75fa8fc275..b6e6f01625 100644 --- a/website/data/en/news/news.toml +++ b/website/data/en/news/news.toml @@ -1,4 +1,9 @@ # Sort news by year, month and day +[[news]] +date = "2021-05-06" +title = "January-March 2021 Status Report" +description = "The <a href=\"https://www.FreeBSD.org/status/report-2021-01-2021-03/\">January to March 2021 Status Report</a> is now available with 28 entries." + [[news]] date = "2021-04-29" description = "New committer: <a href=\"mailto:vishwin@FreeBSD.org\">Charlie Li</a> (ports)"
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202105052346.145NkdGw054036>