FreeBSD Documentation Project TODO list
This is a list of documentation issues that need to be resolved. If you have any updates for this list, please e-mail doceng@FreeBSD.org.
Handbook Items
| Issue | Status | Responsible | Desired Deadline | Description |
|---|---|---|---|---|
| Installation chapter needs to be updated | Not done | Giorgos Keramidas | The installation chapter mostly covers FreeBSD 4.X installation. The current information is often outdated and not accurate for 5.X, 6.X and 7.X. We also have to think about installation on various platforms. This should be done under re@ team responsability since the installation notes have to be updated as well. | |
| Printing chapter lacks a quick and easy setup example | Not done | While this chapter covers in a very accurate way the configuration of a printer under FreeBSD, a quick and easy printer setup should be documented, i.e., something describing the installation and use of apsfilter or equivalent. | ||
| USB printers | Not done | Nowadays printers use the USB interface, the printing chapter may need to be updated on this point. | ||
| Wireless | Not done | Murray Stokely, Marc Fonvieille | The merge of this article in the current wireless section should be done quickly. | |
| IPsec section | Not done | This section still shows the use of gifconfig(4) which is 4.X only. | ||
| USB audio | Not done | One should check if we need to update the sound section for USB devices or if the current guidances are still correct with these devices. | ||
| The Emergency Restore Procedure section (16.12.8) | Not done | This section is really outdated and needs a serious "facelifting." We must show how to restore a system using the livefs from disc1. The rescue system should also be covered. | ||
| Backup Basics (16.12) | Not done | Murray Stokely | Backing up on optical media (CD/DVD) should be presented. | |
| Electronic mail chapter | Not done | Jesus R. Camou | The use of Makefile facilities should be introduced for the sendmail configuration instead of the old outdated way. | |
| inetd | Done | Ceri Davies | For 6.1-RELEASE | The configuration of inetd changed a bit in 6.X, one should check if the related section is still correct. |
| bsnmpd | Not done | The bsnmpd daemon is quite new and its configuration may be complex. The minimal common settings should be introduced in a section of the Network Servers chapter. | ||
| The handbook needs to be updated to match 5.X and beyond | Done | Tom Rhodes | The handbook covers a lot of 4.X material and has 5.X information on the background. The handbook should be updated to remove 4.X material where possible. |
Website
| Issue | Status | Responsible | Desired Deadline | Description |
|---|---|---|---|---|
| New logo | Done | Jun Kuriyama | Add the new logo on our web site layout and create a logo page displaying, and providing information on right logo usage. | |
| Rendering issue | Not done | After the introduction of new layout, many persons reported a font size or rendering problems under some browsers configurations and screen resolutions. These problems should be investigated and fixed. Reference: www/91539 |
Manual Pages
| Issue | Status | Responsible | Desired Deadline | Description |
|---|---|---|---|---|
| bs(4) | Not done | New manual page needed for the WD33C93 SCSI driver | ||
| nss(4) | Not done | New manual page needed for the NEC PC-98 sound support | ||
| ofwcons(4) | Not done | New manual page needed for the IEEE-1275 / Open Firmware | ||
| wds(4) | Not done | New manual page needed for the WD7000 SCSI driver | ||
| xrpu(4) | Not done | New manual page needed for the Xilinx FPGA/RPU driver | ||
| zs(4) | Not done | New manual page needed for the Zilog UART driver | ||
| Write section 9 manual pages | Not done | Tom Rhodes and Hiten Pandya | Document kernel interfaces and functions. | |
| Documenting FreeBSD Tunables | Not done | Tom Rhodes | 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. |
Other Documentations Needs
| Issue | Status | Responsible | Desired Deadline | Description |
|---|---|---|---|---|
| CUPS | Not done | The CUPS system is more and more used, it would be interesting to have an extensive article in our documentation set. This article should cover CUPS installation and configuration (with examples of local and network printers). | ||
| NanoBSD | Done | Giorgos Keramidas | Daniel Geržo contributed both manpage and article for NanoBSD framework. | |
| Architecture Handbook | Not done | The FreeBSD Architecture Handbook is lacking in content, please help us finish this book in writing or updating some chapters. |
Documentation Toolchain Items
| Issue | Status | Responsible | Desired Deadline | Description |
|---|---|---|---|---|
| SGML/XML infrastructure update | In progress | Hiroki Sato | Add more localization support for XML documentation in the doc and www tree. | |
| SGML/XML infrastructure update | In progress | Hiroki Sato | Use SGML/XML catalog for external file reference for consistency. | |
| SGML/XML infrastructure update | In progress | Hiroki Sato | Add standard entity reference (such as à) support in XML/XSLT documentation. |