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. If you have any ideas for a new project then please email FreeBSD-doc@FreeBSD.org.
Current FreeBSD problems reports are tracked using the GNATS database. You can view the open documentation problem reports.
Responsible: Murray Stokely <murray@FreeBSD.org>
Synopsis: Work has begun to prepare the FreeBSD Handbook for publication. See the complete task list for information about how you can help.
Responsible: Murray Stokely <murray@FreeBSD.org>
Synopsis: This project is complete. The 2nd Edition FreeBSD Handbook is available now from The FreeBSD Mall. The final manuscript is 653 pages, and the ISBN number is 1571763031. Thanks to everyone who contributed. Read the full announcement here.
The task list that we used during the development of this book is still archived here for posterity.
Responsible: FreeBSD-doc <FreeBSD-doc@FreeBSD.org>
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).
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: <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>, Wolfram Schneider <wosch@FreeBSD.org>
Synopsis: Modify the CGI scripts url.cgi, ports.cgi, pds.cgi and the script portindex to use the Perl FreeBSD::Ports modules. These modules also need thorough testing.
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 one. Most scripts are written in perl.
Responsible: <doc@FreeBSD.org>
Translate the FreeBSD documentation (Web pages, FAQ, Handbook, Manual pages) into other languages. See the FreeBSD translations projects
Responsible:Eric Anderson <anderson@centtech.com>
When searching the website, the output from the search engine includes the filename that was found, which might be something like FAQ34.html.
It would be more useful if the results included the question text, allowing the user to see whether or not the result was relevant.
Responsible:Tom Rhodes <trhodes@FreeBSD.org>
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.
Responsible: Tom Rhodes <trhodes@FreeBSD.org> and Hiten Pandya <hmp@FreeBSD.org>
Synopsis: Document kernel interfaces and functions.
Synopsis: Write section 4 manual pages.
All drivers in FreeBSD should have a section 4 manual page, but some does not yet.
| Task | Description | Responsible | Last Updated | Status | ||
|---|---|---|---|---|---|---|
| New section 4 manual pages | ||||||
| bs(4) | WD33C93 SCSI driver | 7 November 2003 | &status.new; | |||
| cm(4) | SMC Arcnet network adapters | &a.trhodes; | 7 November 2003 | &status.new; | ||
| ct(4) | WD33C93-based SCSI driver | &a.non; | 21 November 2003 | &status.wip; | ||
| ctx(4) | CORTEX-I Frame Grabber driver | 7 November 2003 | &status.new; | |||
| emu10k1(4) | Soundblaster Pro driver | &a.trhodes;, &a.hmp; | 7 November 2003 | &status.done; | ||
| hea(4) | HARP ATM driver | 7 November 2003 | &status.new; | |||
| hfa(4) | HARP ATM driver | 7 November 2003 | &status.new; | |||
| idt(4) | NICStar ATM Adapter | &a.trhodes;, &a.bms; | 9 November 2003 | &status.done; | ||
| ips(4) | IBM/Adaptec ServerRAID controller | &a.trhodes; | 11 November 2003 | &status.done; | ||
| loran(4) | LORAN-C receiver driver | 7 November 2003 | &status.new; | |||
| mss(4) | AD1848-compatible MSS/WSS driver | 7 November 2003 | &status.new; | |||
| ncv(4) | NCR 53C500 SCSI driver (PC-98) | &a.trhodes; | 20 November 2003 | &status.done; | ||
| nsp(4) | Workbit Ninja SCSI driver (PC-98) | &a.non; | -21 November 2003 | -&status.wip; | +24 November 2003 | +&status.done; |
| nss(4) | NEC PC-98 sound support | 7 November 2003 | &status.new; | |||
| ofwcons(4) | IEEE-1275 / Open Firmware | 7 November 2003 | &status.new; | |||
| rc(4) | Riscom/8 audio driver | 7 November 2003 | &status.new; | |||
| sab(4) | SAB82523 Dual UART driver | 7 November 2003 | &status.new; | |||
| snc(4) | Nat. Semi. DP8393X NIC driver | 7 November 2003 | &status.new; | |||
| spigot(4) | SPIGOT Video Capture driver | 7 November 2003 | &status.new; | |||
| uaudio(4) | USB Audio driver | &a.hmp; | 10 November 2003 | &status.done; | ||
| wdc(4) | &a.rushani; | 8 November 2003 | &status.done; | |||
| xrpu(4) | Xilinx FPGA/RPU driver | 7 November 2003 | &status.new; | |||
| zs(4) | Zilog UART driver | 7 November 2003 | &status.new; | |||
| Legend | |
|---|---|
| &status.new; | Not yet started |
| &status.blocked; | Blocked awaiting completion of another task |
| &status.wip; | Work in progress |
| &status.done; | Task completed |
| &status.n-a; | Not planned |