f08ba66e33
docproj.sgml, and added a new 'docproj' directory which contains other project related .sgml files (and a Makefile). Updated the main Makefile to include this new directory. Reviewed by the various members of the -doc mailing list (including John Fieber) over the past week or so.
104 lines
4.4 KiB
Text
104 lines
4.4 KiB
Text
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY date "$Date: 1998-03-31 20:11:35 $">
|
|
<!ENTITY title "FreeBSD Documentation Project: Current projects">
|
|
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
|
|
]>
|
|
<!-- $Id: current.sgml,v 1.1 1998-03-31 20:11:35 nik Exp $ -->
|
|
|
|
<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.</p>
|
|
|
|
<p>Any ommissions in this list are entirely my fault (Nik Clayton,
|
|
<<a href="mailto:nik@FreeBSD.ORG">nik@FreeBSD.ORG</a>>), sorry
|
|
in advance to anyone whose project I have missed.</p>
|
|
|
|
<h3><font color="#660000">Fixup the FOO.TXT files</font></h3>
|
|
|
|
<p><b>Responsible:</b> Doug <studded@dal.net></p>
|
|
|
|
<p><b>Synopsis:</b> The "FOO.TXT" files are the README files, the
|
|
INSTALL.TXTs. the ABOUT.TXTs and so on that you get with FreeBSD. Doug
|
|
(and others) are going through these trying to make sure they are
|
|
accurate, consistent, and easy to understand. A very worthwhile task.</p>
|
|
|
|
<h3><font color="#660000">Migrate the Handbook from LinuxDoc to DocBook</font></h3>
|
|
|
|
<p><b>Responsible:</b> Nik Clayton <nik@freebsd.org></p>
|
|
|
|
<p><b>Synopsis:</b> The FreeBSD Handbook is being migrated from the
|
|
LinuxDoc DTD to the DocBook DTD. Along the way a few wrinkles are being
|
|
bumped into, particularly involving TeX. A plan has been drawn up,
|
|
preparatory work has been done, but it will be a few weeks before it is
|
|
finished.</p>
|
|
|
|
<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>
|
|
|
|
<h3><font color="#660000">Write the "This is how the Handbook is made" document</font></h3>
|
|
|
|
<p><b>Responsible:</b> No one (although I can offer assistance)</p>
|
|
|
|
<p><b>Synopsis:</b> The mechanism used to put the constituent parts of the
|
|
Handbook together to make the HTML, Postscript, and plain
|
|
text versions is not particularly well documented. If you want
|
|
to learn how this process works, and want to document it as
|
|
well, please get in touch.</p>
|
|
|
|
<p>You will be doing everyone else a big favour, because it then
|
|
makes it much easier for people to contribute documentation
|
|
that can just slot into the Handbook.</p>
|
|
|
|
<h3><font color="#660000">Rewrite the Handbook :-)</font></h3>
|
|
|
|
<p><b>Responsible:</b> No one, yet</p>
|
|
|
|
<p><b>Synopsis:</b> The Handbook has grown quite organically over the
|
|
past few years. This means some of the sections are not organised as
|
|
well as they could be, and some of it needs reworking.</p>
|
|
|
|
<p>Someone needs to</p>
|
|
|
|
<ul>
|
|
<li>Read the Handbook thoroughly</li>
|
|
<li>Come up with a revised structure for it</li>
|
|
<li>Understand how the Handbook is implemented (this will
|
|
mean learning some stuff about SGML, and probably
|
|
liasing with the DocBook migration project)</li>
|
|
<li>Actually do the rework.</li>
|
|
</ul>
|
|
|
|
<p>To break this into manageable chunks, it would be really handy
|
|
if someone could first maintain a web page that lists people's
|
|
current comments about the Handbook structure. That would at
|
|
least give us all something to work from.</p>
|
|
|
|
<p>If no one steps forward to handle this I am going to do
|
|
it. It will just take me a while to get to it (since I need to
|
|
get the DocBook migration out of the way first).</p>
|
|
|
|
&footer
|
|
</body>
|
|
</html>
|