diff options
Diffstat (limited to 'docs-getting-files.xml')
| -rw-r--r-- | docs-getting-files.xml | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/docs-getting-files.xml b/docs-getting-files.xml new file mode 100644 index 0000000..5a4a716 --- /dev/null +++ b/docs-getting-files.xml @@ -0,0 +1,61 @@ +<!-- $Id: docs-getting-files.xml,v 1.1 2003/09/22 16:34:23 tfox Exp $ --> + + <chapter id="ch-getting-files"> + <title>Getting the Files</title> + + <para> + To start working on the Docs Project, you will need the appropriate + DocBook XML files, stylesheets, and scripts. The following packages are + required: + </para> + + <itemizedlist> + <listitem> + <para><filename>xmlto</filename> — for producing HTML and PDF outputs</para> + </listitem> + <listitem> + <para><filename>docbook-style-xsl</filename> — for the default XSLT stylesheets we + build on</para> + </listitem> + <listitem> + <para><filename>docbook-dtds</filename> — XML versions of the DocBook DTD</para> + </listitem> + </itemizedlist> + + <para> + The custom scripts and stylesheets used are all stored in CVS on the + <computeroutput>rhlinux.redhat.com</computeroutput> CVS server. + </para> + + <para> + You need to check them out along with the DocBook XML files for the + existing docs. + </para> + + <para> + To check out the scripts anonymously: + </para> + +<screen> +<command>export CVSROOT=:pserver:anonymous@rhlinux.redhat.com:/usr/local/CVS</command> +<command>cvs -z3 login</command> +<command>cvs -z3 co fedora-docs</command> +</screen> + + <para> + Checking the files out anonymously means that you can view them and + retreive the latest versions, but you can not add (commit) any updates or + new files back to the repository. + </para> + + <para> + Except for the <citetitle>&IG;</citetitle>, all docs must be tutorials + written in DocBook XML article format using the template in the + <filename>example-tutorial</filename> directory. Each tutorial + <emphasis>must</emphasis> be in its own directory. No XML files should be + in the root directory except for files shared by all documents such + <filename>legalnotice.xml</filename>, which must be included in all docs + so that the FDL is used for all docs. + </para> + + </chapter> |