To start working on the Docs Project, you will need the appropriate DocBook XML files, stylesheets, and scripts. The following packages are required:

The custom scripts and stylesheets used are all stored in CVS on the cvs.fedora.redhat.com CVS server. You need to check them out along with the DocBook XML files for the existing docs.

You should perform these steps only once, when you first make a checkout from docs CVS. When you see the password prompt, press the Enter key.

mkdir my-fedora-docs
cd my-fedora-docs
export CVSROOT=:pserver:anonymous@cvs.fedora.redhat.com:/cvs/docs
cvs login
cvs co docs-common
cvs co example-tutorial

When you perform an anonymous CVS checkout, you can view the files and retreive the latest versions. You cannot add (commit) any updates or new files back to the repository. To commit changes to CVS, you must have CVS write access. Refer to http://fedoraproject.org/wiki/DocsProject/NewWriters to learn about getting write access to CVS.

To see a list of the available documents:

cvs co -c

Pick your document of interest and then download it to your working directory:

cvs co example-tutorial

Except for the Installation Guide, all documentation in CVS must be tutorials written in DocBook XML article format using the template in the example-tutorial directory. Each tutorial must be in its own directory. No XML files should be in the root directory.