diff --git a/en/docproj/current.sgml b/en/docproj/current.sgml index 79e617825d..8978f3b45a 100644 --- a/en/docproj/current.sgml +++ b/en/docproj/current.sgml @@ -1,551 +1,530 @@ - + %navincludes; %includes; %developers; "> "> "> "> "> ]> &header;

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.

Open documentation problem reports

Current FreeBSD problems reports are tracked using the GNATS database. You can view the open documentation problem reports.

FreeBSD Handbook 3rd Edition

Responsible: Murray Stokely <murray@FreeBSD.org>

Synopsis: This project is complete. The 3rd Edition FreeBSD Handbook is available now as a 2 volume set from The FreeBSD Mall. Volume 1 ISBN: 1-57176-327-9, Volume 2 ISBN: 1-57176-328-7.

The task list that we used during the development of this book is still archived here for posterity.

The second edition project task list is also still archived here. The second edition manuscript is 653 pages, and the ISBN number is 1-57176-303-1. Thanks to everyone who contributed. Read the full announcement here.

Improve Handbook Index

Responsible: FreeBSD-doc <FreeBSD-doc@FreeBSD.org>

Synopsis: Many new sections have been added to the FreeBSD Handbook without index terms, others have been added under inappropriate primary or secondary indexterms that do not fit the existing scheme. Some indexterms have been added inside list items or other areas where they are not allowed by our stylesheets, causing '???' to be printed in the index instead of a real page number.

Index work requires experience and anyone who works on this task is highly encouraged to carefully read through the existing (print-output) index, and to have read the Chicago Manual of Style or other style books that deal with indexing. Please see the CVS history of some of the chapter.sgml files to see some of the indexing errors that have been corrected in the past. It is imperative to view the PostScript version of the Handbook after making any changes to indexterms as many errors, such as long words or deeply nested indexterms will break the two column output there, or cause the page number to be listed as '???'.

There is a script doc/share/misc/indexreport.pl which can be used to find areas of an SGML file where <indexterms> are sparse.

Improve Firewalls chapter of the Handbook

Responsible: FreeBSD-doc <FreeBSD-doc@FreeBSD.org>

Synopsis: A chapter about Firewalls has recently been added to the FreeBSD Handbook. This new addition is very much a work in progress and there are many grammatical and presentational errors in the chapter. This chapter was previously a large section in the Security chapter, so please see the CVS history of security/chapter.sgml to see some of the work that has been done over the past few months to bring this addition more into line with the Doc Project Primer and the rest of our documentation set. There is still a lot of work to be done, and any and all help is appreciated.

- -

Modernize website with CSS

- -

Responsible: FreeBSD-www <FreeBSD-www@FreeBSD.org>

- -

Synopsis: Most of the FreeBSD.org website is written in - HTML 3.2. Some of the files have been updated to technically - use the HTML 4 DTD, but in spirit they are still HTML 3.2 files - with very minimal use of CSS and extensive use of hardcoded - presentation tags.

- -

Any redesign of the FreeBSD.org website will be more CSS based. - Moving existing pages to CSS allows us to more quickly modify - the look and feel of the entire website and should preserve - bandwidth. As with DocBook for our technical documentation, - recent CSS and HTML standards allow us to separate presentation - from data and we should be taking better advantage of this with - our website.

-

Contribute Advocacy Slides/Presentations

Responsible: FreeBSD-doc <FreeBSD-doc@FreeBSD.org>, Murray Stokely <murray@FreeBSD.org>

Synopsis: Presentations marked up in the DocBook-slides DTD have recently been added to the documentation set in doc/en_US.ISO8859-1/slides. More advocacy content is needed, and additional stylesheet work is needed to pull in content from the release notes and other XML content in our documentation set to build up-to-date slides with 'make'. A simple example presentation was committed with some of this functionality, but there is more work to be done! Also, the stylesheets for print/PDF output (using the Java based XSLT processors, PassiveTeX is too limiting for slides) could be improved as the default DocBook Slides XSL-FO stylesheets produce very spartan slides.

FreeBSD for Linux users

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).

Write a section in the Handbook and/or FAQ

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.

Write some new Papers

The New SCSI layer for FreeBSD (CAM)

Responsible: <doc@FreeBSD.org>, <scsi@FreeBSD.org>

Synopsis: See The Design and Implementation of the FreeBSD SCSI Subsystem for a first snapshot.

Write some chapters for the Developers Handbook

Responsible: <doc@FreeBSD.org>

Synopsis:

CGI Scripts

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.

Multilingual Web scripts

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.

Translations of the FreeBSD Documentation

Responsible: <doc@FreeBSD.org>

Translate the FreeBSD documentation (Web pages, FAQ, Handbook, Manual pages) into other languages. See the FreeBSD translations projects

Search engine enhancements

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.

Documenting FreeBSD Tunables.

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.

Write section 9 manual pages

Responsible: Tom Rhodes <trhodes@FreeBSD.org> and Hiten Pandya <hmp@FreeBSD.org>

Synopsis: Document kernel interfaces and functions.

Write section 4 manual pages

Synopsis: Write section 4 manual pages.

All drivers in FreeBSD should have a section 4 manual page, but some do 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; 21 June 2004 &status.done;
cnw(4) NetWave AirSurfer Wireless LAN &a.brueffer; 10 September 2004 &status.done;
ct(4) WD33C93-based SCSI driver &a.non; 21 November 2003 &status.wip;
digi(4) DigiBoard intelligent serial card driver XXX 7 December 2003 &status.done;
esp(4) QLogic (?) SCSI controller found in Sun Machines &a.trhodes; 21 June 2004 &status.done;
hfa(4) HARP ATM driver &a.trhodes; 6 August 2004 &status.done;
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;
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; 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 communication multiplexor driver &a.trhodes; 21 June 2004 &status.done;
sab(4) SAB82523 Dual UART driver &a.bms; 6 December 2003 &status.done;
snc(4) Nat. Semi. DP8393X NIC driver &a.trhodes; 21 June 2004 &status.done;
snd_emu10k1(4) Soundblaster Pro driver &a.trhodes;, &a.hmp; 7 November 2003 &status.done;
snd_mss(4) AD1848-compatible MSS/WSS driver &a.joel; 10 October 2005 &status.done;
snd_sb8(4) Creative SoundBlaster (pre-16) driver   21 October 2005 &status.new;
snd_sb16(4) Creative SoundBlaster16 driver   21 October 2005 &status.new;
uaudio(4) USB Audio driver &a.hmp; 10 November 2003 &status.done;
wdc(4)   &a.rushani; 8 November 2003 &status.done;
wds(4) WD7000 SCSI driver   24 August 2004 &status.new;
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

FreeBSD Documentation Project Home &footer;