doc/en/docproj/current.sgml
2002-12-14 21:35:04 +00:00

183 lines
7.7 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.37 2002/10/04 04:10:36 bmah Exp $">
<!ENTITY title "FreeBSD Documentation Project: Current projects">
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
]>
<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="#handbook">Handbook 2nd Printed Edition (Completed)</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="#newkernelmanpages">Write Manpages for the kernel</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>
</ul>
<a name="pr"></a>
<h3><font color="#660000">Open documentation problem reports</font></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&amp;responsible=.">view</a>
the open documentation problem reports.</p>
<a name="handbook"></a>
<h3><font color="#660000">FreeBSD Handbook 2nd Edition</font></h3>
<p><b>Responsible:</b> Murray Stokely &lt;<a
href="mailto:murray@FreeBSD.org">murray@FreeBSD.org</a>&gt;</p>
<p><b>Synopsis:</b> This project is complete. The 2nd Edition
FreeBSD Handbook is available now from <a
href="http://www.freebsdmall.com">The FreeBSD Mall</a>. The
final manuscript is 653 pages, and the ISBN number is
1571763031. 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>
<p>The task list that we used during the development of this book
is still archived <a href="handbook.html">here</a> for
posterity.</p>
<a name="freebsd4linux"></a>
<h3><font color="#660000">FreeBSD for Linux users</font></h3>
<p><b>Responsible:</b> FreeBSD-doc
&lt;<a href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>&gt;</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).
<a name="handbooksection"></a>
<h3><font color="#660000">Write a section in the Handbook and/or FAQ</font></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><font color="#660000">Write some new Papers</font></h3>
<h4><font color="#660000">The New SCSI layer for FreeBSD (CAM)</font></h4>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;,
&lt;<a href="mailto:scsi@FreeBSD.org">scsi@FreeBSD.org</a>&gt;</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><font color="#660000">Write some chapters for the Developers Handbook</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;</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="newkernelmanpages"></a>
<h3><font color="#660000">Write Manual pages for the kernel</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;</p>
<p><b>Synopsis:</b> Document kernel functions, section 9</p>
<a name="cgiscripts"></a>
<h3><font color="#660000">CGI Scripts</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;,
Wolfram Schneider &lt;<a href="mailto:wosch@FreeBSD.org">wosch@FreeBSD.org</a>&gt;</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><font color="#660000">Multilingual Web scripts</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;</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><font color="#660000">Translations of the FreeBSD Documentation</font></h3>
<p><b>Responsible:</b>
&lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;</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><font color="#660000">Search engine enhancements</font></h3>
<p><b>Responsible:</b>Eric Anderson &lt;<a href="mailto:anderson@centtech.com">anderson@centtech.com</a>&gt;</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>
<p></p><a href="docproj.html">FreeBSD Documentation Project Home</a>
&footer
</body>
</html>