This is an old revision of the document!
FreeBSD Developer Summit: Documentation
May 16, 2013 13:30-16:30 in MRT 256
Overview
This working group will focus on the FreeBSD documentation, it is generally open to people with an interest in documentation work, as well as src and ports people. If you would like to participate, contact the working group chairs below and CC devsummit@. You will be then added to this page. Please include a list of things you want to talk about or the areas you are interested in. This helps us in planning the session and to bring people together with common interests.
It is possible to bring in people who cannot attend in person via video conference or chat tools. Notes during the session will be published later on for the whole community to see what we discussed.
Goals
In particular, we would like to cover the following topics. This is not an exhaustive list and if you feel there is something missing that you want to talk about, contact one of the session chairs and we will include your topic here. Note that the numbering of the topics does not represent an ordering or importance indication of any kind, but rather a reference to the second table with the “topic of interest” column.
Topics
| # | Topic Description |
|---|---|
| 1 | Handbook print edition (status of ongoing work, what needs to be done, how to involve more people, etc.) |
| 2 | Website redesign (we talked about this in the past, but will revisit it now for possible development in a SVN branch, collect ideas for website features) |
| 3 | Infrastructural changes (DocBook XML changes mostly, might connect to website redesign item) |
| 4 | Recruiting new doc committers/contributors (we need more people to help maintain our documents/website, find mentors, possible candidates, new strategies to involve people) |
| 5 | Helping our translation projects keeping up with changes (ties into the previous item and also possibly the handbook print edition if we want translated versions, finding tools that can help, compare to how PC-BSD is doing it) |
| 6 | Separate doc hackathon (planning, who might be interested in this, time/date, format, location) |
| 7 | Give postmaster@ the permission/training to maintain mailing list entries in the handbook by themselves. At the moment, they need to open a doc PR and a doc committer needs to make the changes, for example, when a new mailing list is created. |
| 8 | Give a few members (portmgr perhaps?) of ports the ability to make changes in the porters handbook without going through an extensive cycle between doc and ports people. A policy needs to be fleshed out to determine boundaries and permissions. |
| 9 | Quality assurance (link checkers, automated igor runs that displays errors on a website) |
Note: General presentations about work you have done that does not require further discussions should be submitted for the FreeBSD Developer Summit track at BSDCan (see the general developer summit page).
Attending
In order to attend you need register for the developer summit as well as by email for the session and be confirmed by the working group organizer. Follow the guidelines described on the main page or what you received by email. For questions or if in doubt ask the session chairs.
Please do NOT add yourself here. Your name will appear automatically once you received the confirmation email. You need to put your name on the general developer summit attendees list though.
| Name | Username / Affiliation | Topics of Interest | Notes |
|---|---|---|---|
| DruLavigne | dru | * | Session chair |
| BenedictReuschling | bcr | * | Session chair |
| MichaelLucas | mwlucas | ||
| MichaelDexter | CallforTesting.org | ||
| Allan Jude | Scale Engine | ||
| EitanAdler | eadler | ||
| GlenBarber | gjb | ||
| WarrenBlock | wblock | ||
| TomRhodes | trhodes |
Notes
The notes for this section are here: http://openetherpad.org/BSDCAN2013DocWG
Results
(Add a list or attach slides detailing the achieved results here.)