initCommon(); include("project.inc"); /***********************************************************************/ /***********************************************************************/ /* Initialize the project */ $project = new Project; /***********************************************************************/ /************************ Begin project content ************************/ /***********************************************************************/ /* Display name is the proper name of the project -- * it is displayed at the top of the page */ $project->display_name="Documentation Project"; $project->project_name="fedora-docs"; $project->bugzilla_component="fedora-docs"; $project->mailing_list="fedora-docs-list"; /* Note: The TODO list is a filename which is * the project_name with a .todo extension */ /* Project description */ $project->desc="

The goal of the Documentation Project is to create easy-to-follow, task-based documentation for $RELEASE_NAME users and developers. Other than the Installation Guide, each document is in article format, with one article per topic. This way, writers can contribute documentation about a specific topic without having to worry about how it fits into a manual or how it flows with other topics. Since the documents are for the $PROJECT_NAME, they only need to describe how to perform tasks on $RELEASE_NAME.

The project maintains some useful pages on the Fedora Project Wiki:

The following tools are used:

HOWEVER, the project takes submissions of new documentation in any format, as there are volunteers who can convert into DocBook/XML. Ongoing maintenance for the new document should happen in DocBook/XML, which is easier to learn from the converted document.

The Documentation Project is not interested in unmaintained documentation. If you have a document to submit, either you or someone else will need to continue maintenance of the document. Documentation should be focused on software found in Fedora Core or Extras. If you have an idea outside of that scope, please bring it to the mailing list for discussion.

For more information about how to participate in this project, read the following:

"; /* custom CVS info */ $project->addMisc("CVS Access","

NOTE: The location for the Documentation Project CVS has recently changed.

export CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs
cvs -z3 login
cvs -z3 co docs-common
cvs -z3 co <name-of-module>

The first check-out command grabs the set of common files you need to build the documents, including stylesheets, common XML components, and stylesheet images. In the second check-out command, replace <name-of-module> with the name of the CVS module you are interested in, such as documentation-guide. If you do not know the name of the document module, you can see a listing of all modules in CVS with these commands:

export CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs
cvs -z3 login
cvs -z3 co -c

For more information on CVS usage, including how to obtain write access, refer to the FDP CVS Usage Guidelines.

"); /* tutorial topics */ $project->addMisc("Tutorial Topics","

Bug 129807 is being used to track tutorials in progress.

Bug 129784 is being used to track tutorial ideas with no writer assigned to them. If you are looking for a topic, refer to this bug to see if anything sparks your interest.

"); $project->addMisc("Fedora Documentation Steering Committee (FDSCo)","

The purpose of FDSCo is to make the Documentation Project a success. Project direction and action can be initiated by the FDSCo. Our main purpose is to clear the way and get stuff done. More information can be found at the FDSCo Wiki pages. Our mailing list is fedora-dsco-list@redhat.com.

FDSCo Members:

"); $project->addMisc("Editors","

After a tutorial has been written, it must be reviewed by a Fedora editor. The role of an editor is defined in the Fedora Documentation Quick Start Guide.

Fedora Editors:

"); /* Contacts */ $project->addMaintainer("Karsten Wade","kwade@redhat.com"); /***********************************************************************/ /************************* End project content *************************/ /***********************************************************************/ $template->options['title'].=': '.$project->display_name; /* Standard template footer */ $template->displayHeader(); /* Display the project content */ $project->displayProject(); /* Standard template footer */ $template->displayFooter('$Date: 2006/12/06 21:36:44 $'); ?>