svn commit: r52319 - head/en_US.ISO8859-1/htdocs/news/status
Edward Tomasz Napierala
trasz at FreeBSD.org
Mon Oct 1 13:51:17 UTC 2018
Author: trasz
Date: Mon Oct 1 13:51:16 2018
New Revision: 52319
URL: https://svnweb.freebsd.org/changeset/doc/52319
Log:
Add Markdown quarterly status report template.
Reviewed by: allanjude, bcr (earlier version)
Approved by: allanjude, bcr (mentors)
Sponsored by: DARPA, AFRL
Differential Revision: https://reviews.freebsd.org/D17329
Added:
head/en_US.ISO8859-1/htdocs/news/status/report-sample.md (contents, props changed)
Modified:
head/en_US.ISO8859-1/htdocs/news/status/status.xml
Added: head/en_US.ISO8859-1/htdocs/news/status/report-sample.md
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/en_US.ISO8859-1/htdocs/news/status/report-sample.md Mon Oct 1 13:51:16 2018 (r52319)
@@ -0,0 +1,30 @@
+## Status Report Sample - This Will Become The Title ##
+
+Contact: John Smith, <email at 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
+
Modified: head/en_US.ISO8859-1/htdocs/news/status/status.xml
==============================================================================
--- head/en_US.ISO8859-1/htdocs/news/status/status.xml Mon Oct 1 13:33:28 2018 (r52318)
+++ head/en_US.ISO8859-1/htdocs/news/status/status.xml Mon Oct 1 13:51:16 2018 (r52319)
@@ -19,7 +19,8 @@
<p>Submit your entries as Pull Requests from your fork of
<a href="https://github.com/freebsd/freebsd-quarterly">FreeBSD
Quarterly Status Reports GitHub repo</a> or submit them via e-mail to
- <a href="mailto:quarterly at FreeBSD.org">quarterly at FreeBSD.org</a>.</p>
+ <a href="mailto:quarterly at FreeBSD.org">quarterly at FreeBSD.org</a>,
+ using the <a href="report-sample.md">Markdown template</a>.</p>
<hr/>
<p>One of the benefits of the FreeBSD development model is a focus on
More information about the svn-doc-head
mailing list