summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs-getting-files-en.xml52
1 files changed, 38 insertions, 14 deletions
diff --git a/docs-getting-files-en.xml b/docs-getting-files-en.xml
index e244aaa..dd6c773 100644
--- a/docs-getting-files-en.xml
+++ b/docs-getting-files-en.xml
@@ -1,6 +1,13 @@
-<!-- $Id: docs-getting-files-en.xml,v 1.2 2005/05/03 18:45:19 pfrields Exp $ -->
+<!-- $Id: -->
+<!--
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
- <chapter id="ch-getting-files">
+ <!ENTITY BOILERPLATE "This header makes editing XML easier" >
+
+]>
+-->
+<chapter id="ch-getting-files">
<title>Getting the Files</title>
<para>
@@ -11,20 +18,20 @@
<itemizedlist>
<listitem>
- <para><filename>xmlto</filename> &mdash; for producing HTML and PDF outputs</para>
+ <para><filename>xmlto</filename> &mdash; for producing HTML and PDF outputs</para>
</listitem>
<listitem>
- <para><filename>docbook-style-xsl</filename> &mdash; for the default XSLT stylesheets we
- build on</para>
+ <para><filename>docbook-style-xsl</filename> &mdash; for the default XSLT stylesheets we
+ build on</para>
</listitem>
<listitem>
- <para><filename>docbook-dtds</filename> &mdash; XML versions of the DocBook DTD</para>
+ <para><filename>docbook-dtds</filename> &mdash; 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.
+ <computeroutput>cvs.fedora.redhat.com</computeroutput> CVS server.
</para>
<para>
@@ -33,29 +40,46 @@
</para>
<para>
- To check out the scripts anonymously:
+ Get started by following these once-only steps.
+ When asked for a <abbrev>CVS</abbrev> password, just press the <guibutton>ENTER</guibutton> key.
</para>
<screen>
-<command>export CVSROOT=:pserver:anonymous@cvs.fedora.redhat.com:/cvs/docs</command>
-<command>cvs -z3 login</command>
-<command>cvs -z3 co fedora-docs</command>
+<prompt>$ </prompt><command>mkdir my-fedora-docs</command>
+<prompt>$ </prompt><command>cd my-fedora-docs</command>
+<prompt>$ </prompt><command>export CVSROOT=:pserver:anonymous@cvs.fedora.redhat.com:/cvs/docs</command>
+<prompt>$ </prompt><command>cvs login</command>
+&lt;enter&gt;
+<prompt>$ </prompt><command>cvs co docs-setup</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.
+ You need <abbrev>CVS</abbrev> write access for that; check with the
+ <ulink url="http://fedoraproject.org/wiki/DocsProject/NewWriters"><filename>http://fedoraproject.org/wiki/DocsProject/NewWriters</filename></ulink>
+ site to learn about getting write access to <abbrev>CVS</abbrev>.
</para>
<para>
+ To see a list of the available documents:
+ </para>
+
+<screen><prompt>$ </prompt><command>cvs co -c</command></screen>
+
+ <para>
+ Pick your document of interest and then download it to your working directory:
+ </para>
+
+<screen><prompt>$ </prompt><command>cvs co example-tutorial</command></screen>
+
+ <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.
+ in the root directory.
</para>
</chapter>