Update a bit this page in adding link and comments about the doc TODO
list. I removed some old things (not all) and merged others in the TODO list. This page is still in WIP state from my point of view.
This commit is contained in:
Marc Fonvieille
parent
ac69e93c1d
commit
1e64a9ea50
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/www/; revision=26979
1 changed files with 16 additions and 309 deletions
|
|
@ -1,6 +1,6 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
|
||||
<!ENTITY base CDATA "..">
|
||||
<!ENTITY date "$FreeBSD: www/en/docproj/current.sgml,v 1.84 2005/10/21 06:56:04 joel Exp $">
|
||||
<!ENTITY date "$FreeBSD: www/en/docproj/current.sgml,v 1.85 2005/12/13 09:40:45 joel Exp $">
|
||||
<!ENTITY title "FreeBSD Documentation Project: Current projects">
|
||||
<!ENTITY % navincludes SYSTEM "../includes.navdocs.sgml"> %navincludes;
|
||||
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
|
||||
|
|
@ -21,10 +21,7 @@
|
|||
&header;
|
||||
|
||||
<p>Here are the projects currently under way (or being actively
|
||||
contemplated on the freebsd-doc mailing list). I have also included some
|
||||
that have not really been talked about, but would probably be a
|
||||
good idea. Each project lists the contact person for that
|
||||
project (if I know who it is).</p>
|
||||
contemplated on the freebsd-doc mailing list).</p>
|
||||
|
||||
<p>If you think you can contribute to any of these, please do not
|
||||
hesitate to stand up and be counted. You should talk to the
|
||||
|
|
@ -34,26 +31,33 @@
|
|||
FreeBSD-doc@FreeBSD.org</a>.</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="#todo">Documentation TODO list</a></li>
|
||||
<li><a href="#pr">Open documentation problem reports</a></li>
|
||||
<li><a href="#handbook3">Handbook 3rd Printed Edition (Completed)</a></li>
|
||||
<li><a href="#handbook-index">Improve Handbook Index</a></li>
|
||||
<li><a href="#handbook-firewalls">Improve Firewalls chapter of the
|
||||
Handbook</a></li>
|
||||
<li><a href="#slides">Contribute Advocacy Slides/Presentations</a></li>
|
||||
<li><a href="#freebsd4linux">FreeBSD for Linux users</a></li>
|
||||
<li><a href="#handbooksection">Write a section in the Handbook and/or FAQ</a></li>
|
||||
<li><a href="#newpapers">Write some new Papers</a></li>
|
||||
<li><a href="#develbook">Write some chapters for the Developers Handbook</a></li>
|
||||
<li><a href="#cgiscripts">CGI Scripts</a></li>
|
||||
<li><a href="#multilingualwebscripts">Multilingual Web scripts</a></li>
|
||||
<li><a href="#translations">Translations of the FreeBSD Documentation</a></li>
|
||||
<li><a href="#search-enhancements">Search engine enhancements</a></li>
|
||||
<li><a href="#tunables">Documenting the FreeBSD tunables</a></li>
|
||||
<li><a href="#newkernelmanpages">Write section 9 manual pages</a></li>
|
||||
<li><a href="#sec4manualpages">Write section 4 manual pages</a></li>
|
||||
|
||||
</ul>
|
||||
|
||||
<a name="todo"></a>
|
||||
<h3>Documentation TODO list</h3>
|
||||
|
||||
<p>The Documentation <a href="todo.html">TODO</a> list is an
|
||||
up-to-date list of documentation issues that should be resolved.
|
||||
This list is posted every month on the <a
|
||||
href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>
|
||||
mailing list. If you wish to help us to improve the FreeBSD
|
||||
documentation set you should, at first, choose to work on one of
|
||||
the TODO list items.</p>
|
||||
|
||||
<a name="pr"></a>
|
||||
<h3>Open documentation problem reports</h3>
|
||||
|
||||
|
|
@ -64,27 +68,6 @@
|
|||
href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=docs&responsible=.">view</a>
|
||||
the open documentation problem reports.</p>
|
||||
|
||||
<a name="handbook3"></a>
|
||||
<h3>FreeBSD Handbook 3rd Edition</h3>
|
||||
|
||||
<p><b>Responsible:</b> Murray Stokely <<a
|
||||
href="mailto:murray@FreeBSD.org">murray@FreeBSD.org</a>></p>
|
||||
|
||||
<p><b>Synopsis:</b> This project is complete. The 3rd Edition
|
||||
FreeBSD Handbook is available now as a 2 volume set from <a
|
||||
href="http://www.freebsdmall.com">The FreeBSD Mall</a>. Volume
|
||||
1 ISBN: 1-57176-327-9, Volume 2 ISBN: 1-57176-328-7.</p>
|
||||
|
||||
<p>The task list that we used during the development of this book
|
||||
is still archived <a href="handbook3.html">here</a> for
|
||||
posterity.</p>
|
||||
|
||||
<p>The second edition project task list is also still archived <a
|
||||
href="handbook.html">here</a>. The second edition manuscript is
|
||||
653 pages, and the ISBN number is 1-57176-303-1. Thanks to
|
||||
everyone who contributed. Read the full announcement <a
|
||||
href="http://docs.FreeBSD.org/cgi/getmsg.cgi?fetch=0+0+archive/2001/freebsd-announce/20011028.freebsd-announce">here</a>.</p>
|
||||
|
||||
<a name="handbook-index"></a>
|
||||
<h3>Improve Handbook Index</h3>
|
||||
|
||||
|
|
@ -96,7 +79,7 @@
|
|||
under inappropriate primary or secondary indexterms that do not
|
||||
fit the existing scheme. Some indexterms have been added inside
|
||||
list items or other areas where they are not allowed by our
|
||||
stylesheets, causing '???' to be printed in the index instead of
|
||||
stylesheets, causing <tt>???</tt> to be printed in the index instead of
|
||||
a real page number.</p>
|
||||
|
||||
<p>Index work requires experience and anyone who works on this
|
||||
|
|
@ -108,28 +91,12 @@
|
|||
It is imperative to view the PostScript version of the Handbook
|
||||
after making any changes to indexterms as many errors, such as
|
||||
long words or deeply nested indexterms will break the two column
|
||||
output there, or cause the page number to be listed as '???'.</p>
|
||||
output there, or cause the page number to be listed as <tt>???</tt>.</p>
|
||||
|
||||
<p>There is a script <tt>doc/share/misc/indexreport.pl</tt> which
|
||||
can be used to find areas of an SGML file where
|
||||
<indexterms> are sparse.</p>
|
||||
|
||||
<a name="handbook-firewalls"></a>
|
||||
<h3>Improve Firewalls chapter of the Handbook</h3>
|
||||
<p><b>Responsible:</b> FreeBSD-doc <<a
|
||||
href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>></p>
|
||||
|
||||
<p><b>Synopsis:</b> A chapter about Firewalls has recently been
|
||||
added to the FreeBSD Handbook. This new addition is very much a
|
||||
work in progress and there are many grammatical and
|
||||
presentational errors in the chapter. This chapter was
|
||||
previously a large section in the Security chapter, so please
|
||||
see the CVS history of <tt>security/chapter.sgml</tt> to see
|
||||
some of the work that has been done over the past few months to
|
||||
bring this addition more into line with the Doc Project Primer
|
||||
and the rest of our documentation set. There is still a lot of
|
||||
work to be done, and any and all help is appreciated.</p>
|
||||
|
||||
<a name="slides"></a>
|
||||
<h3>Contribute Advocacy Slides/Presentations</h3>
|
||||
|
||||
|
|
@ -188,17 +155,6 @@
|
|||
The Design and Implementation of the FreeBSD SCSI Subsystem</a>
|
||||
for a first snapshot.</p>
|
||||
|
||||
<a name="develbook"></a>
|
||||
<h3>Write some chapters for the Developers Handbook</h3>
|
||||
<p><b>Responsible:</b>
|
||||
<<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>></p>
|
||||
|
||||
<p><b>Synopsis:</b></p>
|
||||
<ul>
|
||||
<li>The FreeBSD Developers Handbook is lacking in content, please help
|
||||
us finish this book.</li>
|
||||
</ul>
|
||||
|
||||
<a name="cgiscripts"></a>
|
||||
<h3>CGI Scripts</h3>
|
||||
<p><b>Responsible:</b>
|
||||
|
|
@ -276,255 +232,6 @@
|
|||
and Hiten Pandya <<a href="mailto:hmp@FreeBSD.org">hmp@FreeBSD.org</a>></p>
|
||||
<p><b>Synopsis:</b> Document kernel interfaces and functions.</p>
|
||||
|
||||
|
||||
<a name="sec4manualpages"></a>
|
||||
<h3>Write section 4 manual pages</h3>
|
||||
|
||||
<p><b>Synopsis:</b> Write section 4 manual pages.</p>
|
||||
|
||||
<p>All drivers in FreeBSD should have a section 4 manual page,
|
||||
but some do not yet.</p>
|
||||
|
||||
<table class="tblbasic">
|
||||
<tr class="heading">
|
||||
<th> Task </th>
|
||||
<th> Description </th>
|
||||
<th> Responsible </th>
|
||||
<th> Last Updated </th>
|
||||
<th> Status </th>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td colspan="5" class="section"> New section 4 manual pages </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> bs(4) </td>
|
||||
<td> WD33C93 SCSI driver</td>
|
||||
<td> </td>
|
||||
<td> 7 November 2003 </td>
|
||||
<td> &status.new; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> cm(4) </td>
|
||||
<td> SMC Arcnet network adapters</td>
|
||||
<td> &a.trhodes; </td>
|
||||
<td> 21 June 2004 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> cnw(4) </td>
|
||||
<td> NetWave AirSurfer Wireless LAN </td>
|
||||
<td> &a.brueffer; </td>
|
||||
<td> 10 September 2004 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> ct(4) </td>
|
||||
<td> WD33C93-based SCSI driver</td>
|
||||
<td> &a.non; </td>
|
||||
<td> 21 November 2003 </td>
|
||||
<td> &status.wip; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> digi(4) </td>
|
||||
<td> DigiBoard intelligent serial card driver</td>
|
||||
<td> XXX </td>
|
||||
<td> 7 December 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> esp(4) </td>
|
||||
<td> QLogic (?) SCSI controller found in Sun Machines </td>
|
||||
<td> &a.trhodes; </td>
|
||||
<td> 21 June 2004 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> hfa(4) </td>
|
||||
<td> HARP ATM driver</td>
|
||||
<td> &a.trhodes; </td>
|
||||
<td> 6 August 2004 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> idt(4) </td>
|
||||
<td> NICStar ATM Adapter</td>
|
||||
<td> &a.trhodes;, &a.bms; </td>
|
||||
<td> 9 November 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> ips(4) </td>
|
||||
<td> IBM/Adaptec ServerRAID controller</td>
|
||||
<td> &a.trhodes; </td>
|
||||
<td> 11 November 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> ncv(4) </td>
|
||||
<td> NCR 53C500 SCSI driver (PC-98)</td>
|
||||
<td> &a.trhodes; </td>
|
||||
<td> 20 November 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> nsp(4) </td>
|
||||
<td> Workbit Ninja SCSI driver (PC-98)</td>
|
||||
<td> &a.non; </td>
|
||||
<td> 24 November 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> nss(4) </td>
|
||||
<td> NEC PC-98 sound support</td>
|
||||
<td> </td>
|
||||
<td> 7 November 2003 </td>
|
||||
<td> &status.new; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> ofwcons(4) </td>
|
||||
<td> IEEE-1275 / Open Firmware</td>
|
||||
<td> </td>
|
||||
<td> 7 November 2003 </td>
|
||||
<td> &status.new; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> rc(4) </td>
|
||||
<td> Riscom/8 communication multiplexor driver</td>
|
||||
<td> &a.trhodes; </td>
|
||||
<td> 21 June 2004 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> sab(4) </td>
|
||||
<td> SAB82523 Dual UART driver</td>
|
||||
<td> &a.bms; </td>
|
||||
<td> 6 December 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> snc(4) </td>
|
||||
<td> Nat. Semi. DP8393X NIC driver</td>
|
||||
<td> &a.trhodes; </td>
|
||||
<td> 21 June 2004 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> snd_emu10k1(4) </td>
|
||||
<td> Soundblaster Pro driver</td>
|
||||
<td> &a.trhodes;, &a.hmp;</td>
|
||||
<td> 7 November 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> snd_mss(4) </td>
|
||||
<td> AD1848-compatible MSS/WSS driver</td>
|
||||
<td> &a.joel; </td>
|
||||
<td> 10 October 2005 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> snd_sb8(4) </td>
|
||||
<td> Creative SoundBlaster (pre-16) driver</td>
|
||||
<td> </td>
|
||||
<td> 21 October 2005 </td>
|
||||
<td> &status.new; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> snd_sb16(4) </td>
|
||||
<td> Creative SoundBlaster16 driver</td>
|
||||
<td> </td>
|
||||
<td> 21 October 2005 </td>
|
||||
<td> &status.new; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> uaudio(4) </td>
|
||||
<td> USB Audio driver</td>
|
||||
<td> &a.hmp; </td>
|
||||
<td> 10 November 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> wdc(4) </td>
|
||||
<td> </td>
|
||||
<td> &a.rushani; </td>
|
||||
<td> 8 November 2003 </td>
|
||||
<td> &status.done; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> wds(4) </td>
|
||||
<td> WD7000 SCSI driver </td>
|
||||
<td> </td>
|
||||
<td> 24 August 2004 </td>
|
||||
<td> &status.new; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> xrpu(4) </td>
|
||||
<td> Xilinx FPGA/RPU driver</td>
|
||||
<td> </td>
|
||||
<td> 7 November 2003 </td>
|
||||
<td> &status.new; </td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td> zs(4) </td>
|
||||
<td> Zilog UART driver</td>
|
||||
<td> </td>
|
||||
<td> 7 November 2003 </td>
|
||||
<td> &status.new; </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br><br>
|
||||
|
||||
<table class="tblbasic">
|
||||
<tr class="heading">
|
||||
<th colspan="2">Legend</th>
|
||||
</tr><tr>
|
||||
<td> &status.new; </td>
|
||||
<td> Not yet started </td>
|
||||
</tr><tr>
|
||||
<td> &status.blocked; </td>
|
||||
<td> Blocked awaiting completion of another task </td>
|
||||
</tr><tr>
|
||||
<td> &status.wip; </td>
|
||||
<td> Work in progress </td>
|
||||
</tr><tr>
|
||||
<td> &status.done; </td>
|
||||
<td> Task completed </td>
|
||||
</tr><tr>
|
||||
<td> &status.n-a; </td>
|
||||
<td> Not planned </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br>
|
||||
|
||||
<p></p><a href="docproj.html">FreeBSD Documentation Project Home</a>
|
||||
&footer;
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
Loading…
Reference in a new issue