b9bd1d846f
Submitted by: Emily Boyd <emilyboyd@emilyboyd.com> Sponsored by: Google Summer of Code 2005
535 lines
18 KiB
Text
535 lines
18 KiB
Text
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY date "$FreeBSD: www/en/docproj/current.sgml,v 1.81 2005/06/11 23:06:56 murray Exp $">
|
|
<!ENTITY title "FreeBSD Documentation Project: Current projects">
|
|
<!ENTITY % navincludes SYSTEM "../includes.navdocs.sgml"> %navincludes;
|
|
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
|
|
<!ENTITY % developers SYSTEM "../developers.sgml"> %developers;
|
|
|
|
<!ENTITY imagebase "&base;/gifs">
|
|
|
|
<!-- Status levels -->
|
|
<!ENTITY status.blank " ">
|
|
<!ENTITY status.blocked "<img src='&imagebase;/blocked.png' width='22' height='22' alt='Blocked'>">
|
|
<!ENTITY status.done "<img src='&imagebase;/done.png' width='22' height='22' alt='Done'>">
|
|
<!ENTITY status.new "<img src='&imagebase;/not_started.png' width='22' height='22' alt='Not Started'>">
|
|
<!ENTITY status.n-a "<img src='&imagebase;/not_planned.png' width='22' height='22' alt='Not Planned'>">
|
|
<!ENTITY status.wip "<img src='&imagebase;/in_progress.png' width='22' height='22' alt='In progress'>">
|
|
]>
|
|
|
|
<html>
|
|
&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>
|
|
|
|
<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
|
|
person responsible for that particular project, who can then bring you
|
|
up to speed on what is happening. If you have any ideas for a new
|
|
project then please email <a href="mailto:FreeBSD-doc@FreeBSD.org">
|
|
FreeBSD-doc@FreeBSD.org</a>.</p>
|
|
|
|
<ul>
|
|
<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="#website-css">Modernize website with CSS</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="pr"></a>
|
|
<h3>Open documentation problem reports</h3>
|
|
|
|
<p>Current FreeBSD problems reports are tracked using the GNATS
|
|
database.
|
|
|
|
You can <a
|
|
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>
|
|
|
|
<p><b>Responsible:</b> FreeBSD-doc <<a
|
|
href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>></p>
|
|
|
|
<p><b>Synopsis:</b> Many new sections have been added to the
|
|
FreeBSD Handbook without index terms, others have been added
|
|
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
|
|
a real page number.</p>
|
|
|
|
<p>Index work requires experience and anyone who works on this
|
|
task is highly encouraged to carefully read through the existing
|
|
(print-output) index, and to have read the Chicago Manual of
|
|
Style or other style books that deal with indexing. Please see
|
|
the CVS history of some of the chapter.sgml files to see some of
|
|
the indexing errors that have been corrected in the past.
|
|
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>
|
|
|
|
<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="website-css"></a>
|
|
<h3>Modernize website with CSS</h3>
|
|
|
|
<p><b>Responsible:</b> FreeBSD-www <<a
|
|
href="mailto:FreeBSD-www@FreeBSD.org">FreeBSD-www@FreeBSD.org</a>></p>
|
|
|
|
<p><b>Synopsis:</b> Most of the FreeBSD.org website is written in
|
|
HTML 3.2. Some of the files have been updated to technically
|
|
use the HTML 4 DTD, but in spirit they are still HTML 3.2 files
|
|
with very minimal use of CSS and extensive use of hardcoded
|
|
presentation tags.</p>
|
|
|
|
<p>Any redesign of the FreeBSD.org website will be more CSS based.
|
|
Moving existing pages to CSS allows us to more quickly modify
|
|
the look and feel of the entire website and should preserve
|
|
bandwidth. As with DocBook for our technical documentation,
|
|
recent CSS and HTML standards allow us to separate presentation
|
|
from data and we should be taking better advantage of this with
|
|
our website.</p>
|
|
|
|
<a name="slides"></a>
|
|
<h3>Contribute Advocacy Slides/Presentations</h3>
|
|
|
|
<p><b>Responsible:</b> FreeBSD-doc
|
|
<<a
|
|
href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>>,
|
|
Murray Stokely <<a
|
|
href="mailto:murray@FreeBSD.org">murray@FreeBSD.org</a>></p>
|
|
|
|
<p><b>Synopsis:</b> Presentations marked up in the DocBook-slides
|
|
DTD have recently been added to the documentation set in
|
|
<tt>doc/en_US.ISO8859-1/slides</tt>. More advocacy content is
|
|
needed, and additional stylesheet work is needed to pull in
|
|
content from the release notes and other XML content in our
|
|
documentation set to build up-to-date slides with 'make'. A
|
|
simple example presentation was committed with some of this
|
|
functionality, but there is more work to be done! Also, the
|
|
stylesheets for print/PDF output (using the Java based XSLT
|
|
processors, PassiveTeX is too limiting for slides) could be
|
|
improved as the default DocBook Slides XSL-FO stylesheets
|
|
produce very spartan slides.</p>
|
|
|
|
<a name="freebsd4linux"></a>
|
|
<h3>FreeBSD for Linux users</h3>
|
|
|
|
<p><b>Responsible:</b> FreeBSD-doc
|
|
<<a href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>></p>
|
|
|
|
<p><b>Synopsis:</b> Linux users coming to FreeBSD can be confused by
|
|
some of the differences between the systems (the different default
|
|
shells, how boot time configuration is performed, and so on).</p>
|
|
|
|
<a name="handbooksection"></a>
|
|
<h3>Write a section in the Handbook and/or FAQ</h3>
|
|
|
|
<p><b>Responsible:</b> No one</p>
|
|
|
|
<p><b>Synopsis:</b> Chunks of the FAQ and Handbook have empty sections in
|
|
them. They need filling. If you have just had to use one of
|
|
these documents to complete a task, and found them lacking,
|
|
please find the time to write up your experiences as a
|
|
possible replacement.</p>
|
|
|
|
<p>Alternatively, if you have just had to do something that had no
|
|
entry in the FAQ and/or Handbook, please consider writing a
|
|
new section. Then submit it as outlined above.</p>
|
|
|
|
<a name="newpapers"></a>
|
|
<h3>Write some new Papers</h3>
|
|
|
|
<h4><font color="#660000">The New SCSI layer for FreeBSD (CAM)</font></h4>
|
|
<p><b>Responsible:</b>
|
|
<<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>>,
|
|
<<a href="mailto:scsi@FreeBSD.org">scsi@FreeBSD.org</a>></p>
|
|
<p><b>Synopsis:</b> See <a href="http://www.FreeBSD.org/~gibbs/">
|
|
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>
|
|
<<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>>,
|
|
Wolfram Schneider <<a href="mailto:wosch@FreeBSD.org">wosch@FreeBSD.org</a>></p>
|
|
|
|
<p><b>Synopsis:</b> Modify the CGI scripts url.cgi, ports.cgi,
|
|
pds.cgi and the script portindex to use the Perl <a
|
|
href="http://people.FreeBSD.org/~tom/portpm/">FreeBSD::Ports</a>
|
|
modules. These modules also need thorough testing.</p>
|
|
|
|
<a name="multilingualwebscripts"></a>
|
|
<h3>Multilingual Web scripts</h3>
|
|
|
|
<p><b>Responsible:</b>
|
|
<<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>></p>
|
|
<p></p>
|
|
|
|
<p><b>Synopsis:</b></p>
|
|
|
|
<p>
|
|
Our main Web pages are written in (American) English. The <a
|
|
href="translations.html">FreeBSD Translations Projects</a>
|
|
translate the web pages, Handbook and FAQ to other languages.</p>
|
|
|
|
<p>
|
|
We must translate the cgi scripts and web build scripts too. The
|
|
scripts should support multiple languages, not only one.
|
|
Most scripts are written in perl.</p>
|
|
|
|
<ul>
|
|
<li>Merge the perl scripts <a
|
|
href="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/www/en/ports/portindex">www/en/ports/portindex</a>
|
|
and <a
|
|
href="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/www/ja/ports/portindex">www/ja/ports/portindex</a>
|
|
into one script. Add an option for English and Japanese output.
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<a name="translations"></a>
|
|
<h3>Translations of the FreeBSD Documentation</h3>
|
|
<p><b>Responsible:</b>
|
|
<<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>></p>
|
|
<p>
|
|
Translate the FreeBSD documentation (Web pages, FAQ,
|
|
Handbook, Manual pages) into other languages. See the
|
|
<a href="translations.html">FreeBSD translations projects</a></p>
|
|
|
|
<a name="search-enhancements"></a>
|
|
<h3>Search engine enhancements</h3>
|
|
<p><b>Responsible:</b>Eric Anderson <<a href="mailto:anderson@centtech.com">anderson@centtech.com</a>></p>
|
|
|
|
<p>When searching the website, the output from the search engine includes
|
|
the filename that was found, which might be something like
|
|
<tt>FAQ34.html</tt>.</p>
|
|
|
|
<p>It would be more useful if the results included the question text,
|
|
allowing the user to see whether or not the result was relevant.</p>
|
|
|
|
<a name="tunables"></a>
|
|
<h3>Documenting FreeBSD Tunables.</h3>
|
|
<p><b>Responsible:</b>Tom Rhodes <<a href="mailto:trhodes@FreeBSD.org">trhodes@FreeBSD.org</a>></p>
|
|
|
|
<p>Many FreeBSD tunables are undocumented. Everyone knows how difficult
|
|
it can be to use an undocumented system, and thus this project was formed.
|
|
The initial goal here is to create a tool which can generate a manual page
|
|
with the tunables. Hence we need to generate this list from the source
|
|
code.</p>
|
|
|
|
<a name="newkernelmanpages"></a>
|
|
<h3>Write section 9 manual pages</h3>
|
|
<p><b>Responsible:</b>
|
|
Tom Rhodes <<a href="mailto:trhodes@FreeBSD.org">trhodes@FreeBSD.org</a>>
|
|
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> 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> 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> mss(4) </td>
|
|
<td> AD1848-compatible MSS/WSS driver</td>
|
|
<td> </td>
|
|
<td> 7 November 2003 </td>
|
|
<td> &status.new; </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> 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>
|