diff --git a/en/docproj/Makefile b/en/docproj/Makefile index 48e9c18d74..cdbef9f5fc 100644 --- a/en/docproj/Makefile +++ b/en/docproj/Makefile @@ -1,20 +1,21 @@ -# $FreeBSD: www/en/docproj/Makefile,v 1.7 1999/09/06 07:02:43 peter Exp $ +# $FreeBSD: www/en/docproj/Makefile,v 1.8 2000/11/07 04:05:14 kuriyama Exp $ .if exists(../Makefile.conf) .include "../Makefile.conf" .endif .if exists(../Makefile.inc) .include "../Makefile.inc" .endif DOCS= current.sgml DOCS+= doc-set.sgml +DOCS+= handbook.sgml DOCS+= sgml.sgml DOCS+= submitting.sgml DOCS+= who.sgml DOCS+= translations.sgml DOCS+= docproj.sgml INDEXLINK= docproj.html .include "${WEB_PREFIX}/share/mk/web.site.mk" diff --git a/en/docproj/current.sgml b/en/docproj/current.sgml index d01ce834ae..9120ce4aa2 100644 --- a/en/docproj/current.sgml +++ b/en/docproj/current.sgml @@ -1,227 +1,243 @@ - + %includes; ]> &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.

Any omissions in this list are entirely my fault (Nik Clayton, <nik@FreeBSD.ORG>), sorry in advance to anyone whose project I have missed.

Open documentation problem reports

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

+ +

FreeBSD Handbook 2nd Edition

+ +

Responsible: Murray Stokely <murray@FreeBSD.org>

+ +

Synopsis: Wind River Systems is publishing a 2nd Edition + of the FreeBSD Handbook. The book has been completely indexed, + ASCII art is being replaced with proper diagrams, and a lot of + additional content has been written. However, there is still a + ton of work that needs to be done.

+ +

The current task list is available online.

+

FreeBSD for Linux users

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.

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 new Tutorials

Responsible: <doc@FreeBSD.org>

Synopsis:

Write Manpages for the kernel

Responsible: <doc@FreeBSD.org>

Synopsis: Document kernel functions, section 9

CGI Scripts

Responsible: <doc@FreeBSD.org>, Wolfram Schneider <wosch@FreeBSD.org>

Synopsis:

Here are some hints how to write the ports module

A single line in /usr/ports/INDEX looks like

    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
         

The format is

    distribution-name|port-path|installation-prefix|comment| \
        description-file|maintainer|categories|build deps|run deps
        

The above INDEX line parsed into an anonymous hash object

 $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'] 
 };
       

Now we need some functions

Finally

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.

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, manpages) into other languages. See the FreeBSD translations projects

Search engine enhancements

Responsible: <doc@FreeBSD.org>

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.

FreeBSD Documentation Project Home &footer diff --git a/en/docproj/handbook.sgml b/en/docproj/handbook.sgml new file mode 100644 index 0000000000..4979f0297d --- /dev/null +++ b/en/docproj/handbook.sgml @@ -0,0 +1,302 @@ + + + + %includes; +]> + + + &header; + +

FreeBSD Handbook 2nd Edition

+ +

The FreeBSD + Handbook is currently being prepared for publication. This + second edition of the Handbook will be fully indexed, use proper + diagrams instead of ASCII artwork, and have nearly twice the + content of the 1st edition.

+ +

There is still a ton of work that needs to be done before + September 15th, when the Handbook is scheduled to go off to the + presses. If you feel like you can contribute to anything listed + below or to any other enhancements you feel the Handbook needs, + then please contact the -doc list.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TaskResponsibleLast +updatedStatus
Create proposal for Wind River managementMurrayMay 17, 2001Done
Add a section on headless installsValMay 11, 2001Done
Add a section on installing and using XDMSethMay 23, 2001Done
Add section 4.3 on "Using the Packages System".ChernJune 15, 2001Done
Fix index generation infrastructure in doc.docbook.mkNikJune 19, 2001Done
Add a section on installing and using XFree86 4.xChris ShumwayJuly 11, 2001Done
Add a section on installing and using KDE, Gnome, etc.ValJune, 2001Done
Add a section about amdWylieMay 11, 2001Stalled
Add a chapter about configuration and tuning of FreeBSDChern, MurrayJuly 10, 2001Done
Write post-processing script to clean up indexing outputMurrayJune 19, 2001Not Started (not necessary?)
Replace ASCII art with proper figures (17.2.2, 17.6.3, etc..)ChernJuly 11, 2001In Progress
Add index entries to Chapters 1-2MurrayJune 24, 2001Done
Add index entries to Chapters 3-4ValJuly 11, 2001Done
Add index entries to Chapters 5-6ValJuly 11, 2001Done
Add index entries to Chapters 7-8ValJune 19, 2001Done
Add index entries to Chapters 9-10MurrayJune 24, 2001Done
Add index entries to Chapters 11-12MurrayJune 30, 2001Done
Add index entries to Chapter 13ChrisJuly 11, 2001In Progress
Add index entries to Chapter 14-15MurrayJune 30, 2001Done
Add index entries to Chapters 21-22ValJuly 20, 2001Done
Fix cross-referencing tags to look better in the print + output.MurrayJuly 20, 2001In Progress
Add a tuneable knob to remove PGP keys in print outputMurrayJuly 11, 2001Done
Clear up copyright issuesNikJuly 11, 2001Not Started
Enclose author attributions in proper tagMurrayJuly 20, 2001In progress
Standardize spelling of technical termsMurray, ChernJuly 20, 2001In progress
Make sure all filenames, commands, applications, hostnames, etc + are marked up properlyMurray, ChernJuly 20, 2001In progress
Write collateattributions.pl script to generate a appendix full + of contributing authors.MurrayJuly 11, 2001Not Started
Add index entries to remaining ChaptersNot Started
Rewrite most of the X11 chapter and get rid of all of Greg + Lehey's original content.MurrayJuly 20, 2001In Progress
Update PPP/SLIP chapterrope Brian Somers into it ;)Not Started
Update Serial chapterNikNot Started
Get rid of Appendix FMurrayJuly 13Done
Move out-of-scope chapters into Developer's HandbookMurrayJuly 19Done
Enhance chapter header print output in stylesheets.MurrayJuly 19In Progress
Setup a WRS CVS server for the last phase of editingMurray, SethNot started
Remove outdated chapters and appendices from local CVS tree.MurrayJune 21, 2001Not started
Add simple illustrations at the beginning of each Part.Ellen / WRS ArtJuly 20, 2001Not started
Add admonition graphics for Note, Caution, Warning, Tip.Ellen / WRS ArtJuly 20, 2001Not started
Rewrite Install chapter with sysinstall screenshots, etc from + Randy Pratt's install guide.Murray, Randy PrattJuly 20, 2001In progress
Update and add more content to Introduction chapter.rope jkh into itJuly 20, 2001Not started
Update backups chapterMurrayJuly 20, 2001In Progress
Review chapters 1-3 for grammatical errors.ChernMay 11, 2001Not started
Review chapters 4-6 for grammatical errors.SethMay 11, 2001Not started
Review the rest of the book for grammatical errors.Not started
+ + + \ No newline at end of file