os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

status: Correct link to template and wordsmith phrasing

Browse source 
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.
This commit is contained in:
Daniel Ebdrup Jensen 2021-02-14 08:06:05 +01:00
parent 925b9be6f3
commit fee800a873
3 changed files with 2 additions and 32 deletions
website/content/en/status
README_index.adocreport-sample.md

2
website/content/en/status/README
View file

@ -75,7 +75,7 @@ quarterly-submissions@FreeBSD.org
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

2
website/content/en/status/_index.adoc
View file

@ -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 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].
'''''

30
website/content/en/status/report-sample.md
View file

@ -1,30 +0,0 @@
## Status Report Sample - This Will Become The Title ##
Contact: Full Name, <email@example.org>
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