git: fee800a873 - main - status: Correct link to template and wordsmith phrasing
Daniel Ebdrup Jensen <[email protected]>
| Newsgroups | gmane.os.freebsd.devel.cvs.doc |
|---|---|
| Message-ID | <[email protected]> |
The branch main has been updated by debdrup: URL: https://cgit.FreeBSD.org/doc/commit/?id=fee800a873f23588314e21f650165bcaee0dc149 commit fee800a873f23588314e21f650165bcaee0dc149 Author: Daniel Ebdrup Jensen <[email protected]> AuthorDate: 2021-02-14 07:06:05 +0000 Commit: Daniel Ebdrup Jensen <[email protected]> CommitDate: 2021-02-14 07:20:41 +0000 status: Correct link to template and wordsmith phrasing Pursuant to the DocBook->AsciiDoctor migration, status reports are similarily moving from MarkDown to AsdiiDoctor, as there should be no functional change in how report entries are handled by commiters or contributors. While here, remove sample file that has never been referred to anywhere, and update the README used by the status project team. --- website/content/en/status/README | 2 +- website/content/en/status/_index.adoc | 2 +- website/content/en/status/report-sample.md | 30 ------------------------------ 3 files changed, 2 insertions(+), 32 deletions(-) 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 @@ -75,7 +75,7 @@ [email protected] 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 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 @@ -7,7 +7,7 @@ sidenav: about == 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 [email protected], 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 [email protected], using the link:https://github.com/freebsd/freebsd-quarterly/blob/master/report-sample.adoc[report-sample.adoc template]. ''''' 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, <[email protected]> - -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 - _______________________________________________ [email protected] mailing list https://lists.freebsd.org/mailman/listinfo/dev-commits-doc-all To unsubscribe, send any mail to "[email protected]"