documentation-guide docs-getting-files-en.xml,1.2,1.3

Tommy Reynolds (jtr) fedora-docs-commits at redhat.com
Sat May 14 20:00:17 UTC 2005


Author: jtr

Update of /cvs/docs/documentation-guide
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv24343/documentation-guide

Modified Files:
	docs-getting-files-en.xml 
Log Message:
1) Changed to reflect the updated CVS arrangement with modules as "top-level"
   objects.

2) Changed URL for :pserver: CVS access.

3) Added short section on :ext: CVS access with reference to the WIKI doc.



Index: docs-getting-files-en.xml
===================================================================
RCS file: /cvs/docs/documentation-guide/docs-getting-files-en.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- docs-getting-files-en.xml	3 May 2005 18:45:19 -0000	1.2
+++ docs-getting-files-en.xml	14 May 2005 20:00:15 -0000	1.3
@@ -1,6 +1,13 @@
-<!-- $Id$ -->
-
-  <chapter id="ch-getting-files">
+<!-- $Id: -->
+<!--
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+ <!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> — for producing HTML and PDF outputs</para>
+  <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>
+  <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>
+  <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.
+      <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 at 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 at cvs.fedora.redhat.com:/cvs/docs</command>
+<prompt>$ </prompt><command>cvs login</command>
+<enter>
+<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>




More information about the Fedora-docs-commits mailing list