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).
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.
Any ommissions in this list are entirely my fault (Nik Clayton, <nik@FreeBSD.ORG>), sorry in advance to anyone whose project I have missed.
Responsible: Annelise Anderson <andrsn@andrsn.stanford.edu>
Synopsis: 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). Annelise is coordinating the development of a tutorial/FAQ section that will address these points.
The list of current questions is at http://freebsd.stanford.edu/FreeBSD/linux.html.
Responsible: Doug <studded@dal.net>
Synopsis: 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.
Responsible: Nik Clayton <nik@freebsd.org>
Synopsis: 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.
Responsible: No one
Synopsis: 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.
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.
Responsible: No one (although I can offer assistance)
Synopsis: 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.
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.
Responsible: No one, yet
Synopsis: 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.
Someone needs to
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.
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).
Responsible: John Dyson < dyson@iquest.net
Synopsis: FreeBSD 2.x has a completly rewritten virtual memory architecture. Unfortunately there is no documentation available about the FreeBSD VM architecture execpt the source code and some old E-Mails from John Dyson. See FreeBSD VM System Overview for a first snapshot.
Responsible: <doc@freebsd.org>, <scsi@freebsd.org>
Synopsis: See The Design and Implementation of the FreeBSD SCSI Subsystem for a first snapshot.
Responsible: <doc@freebsd.org
Synopsis:
Responsible: <doc@freebsd.org
Synopsis: Document kernel functions, section 9
Responsible: <doc@freebsd.org, Wolfram Schneider < wosch@freebsd.org
Synopsis:
xfig-3.2.2|/usr/ports/graphics/xfig|/usr/X11R6|A drawing program for X11|/usr/ports/graphics/xfig/pkg/DESCR|ports@FreeBSD.ORG|graphics x11|XFree86-3.3.2 Xaw3d-1.3 jpeg-6b xpm-3.4k|XFree86-3.3.2 Xaw3d-1.3 jpeg-6b netpbm-94.3.1 tiff-3.4 transfig-3.2 xpm-3.4k
distribution-name|port-path|installation-prefix|comment| \
description-file|maintainer|categories|build deps|run deps
$port = {
DISTRIBUTION_NAME => 'xfig-3.2.2',
PORT_PATH => '/usr/ports/graphics/xfig',
INSTALLATION_PREFIX => '/usr/X11R6',
COMMENT => 'A drawing program for X11',
DESCRIPTION_FILE => '/usr/ports/graphics/xfig/pkg/DESCR',
MAINTAINER => 'ports@FreeBSD.ORG',
CATEGORIES => ['graphics', 'x11'],
BUILD_DEPS => ['XFree86-3.3.2', 'Xaw3d-1.3', 'jpeg-6b',
'xpm-3.4k'],
RUN_DEPS => ['XFree86-3.3.2', 'Xaw3d-1.3', 'jpeg-6b',
'netpbm-94.3.1', 'tiff-3.4', 'transfig-3.2',
'xpm-3.4k']
};
Modify the cgi script url.cgi, ports.cgi , pds.cgi and the script portindex to use this module.
Contact Nik Clayton <nik@FreeBSD.ORG> for a first snapshot of the ports module.
Responsible: <doc@freebsd.org>
Synopsis: Our main Web pages are written in (American) English. The FreeBSD Translations Projects translate the web pages, Handbook and FAQ to other languages.
We must translate the cgi scripts and web build scripts too. The scripts should support multiple languages, not only once. Most scripts are written in perl.
Responsible: <doc@freebsd.org Translate the FreeBSD documentation (Web pages, FAQ, handbook, manpages) into other languages. See the FreeBSD translations projects
FreeBSD Documentation Project Home &footer