renaming rh-guidelines to writing-guidelines

1 files changed, 115 insertions, 0 deletions

diff --git a/en_US/getting-files.xml b/en_US/getting-files.xml
new file mode 100644
index 0000000..c86a6d4
--- /dev/null
+++ b/en_US/getting-files.xml
@@ -0,0 +1,115 @@
+<!-- $Id: -->
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- *************** Bring in Fedora entities *************** -->
+<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "fdp-entities.ent">
+%FEDORA-ENTITIES-EN;
+
+]>
+
+<chapter id="ch-getting-files">
+  <title>Prerequisites</title>
+
+  <para>
+    To work on official &FED; documentation you need to install the required
+    tools.  Follow the directions below to configure your system.
+  </para>
+
+  <section id="ch-getting-files-system-packages">
+    <title>System Packages</title>
+
+    <para>
+      Install the "Authoring and Publishing" package group, which contains
+      required DocBook XML files, stylesheets and scripts:
+    </para>
+
+<screen>
+<userinput>su -c 'yum groupinstall "Authoring and Publishing"'</userinput>
+</screen>
+
+    <para>
+      Next, install the <filename>cvs</filename> package, which is used to
+      handle revision control on files in the official repository:
+    </para>
+
+<screen>
+<userinput>su -c 'yum install cvs'</userinput>
+</screen>
+
+  </section>
+
+  <section id="ch-getting-files-fdp">
+    <title>Fedora Documentation Tools</title>
+
+    <para>
+      The &FDP;'s custom scripts and stylesheets are stored in CVS on the
+      <systemitem class="fqdomainname">cvs.fedoraproject.org</systemitem> CVS
+      server.  Check them out along with the DocBook XML files for the existing
+      docs.
+    </para>
+
+<screen>
+<userinput>mkdir <replaceable>my-fedora-docs-sandbox</replaceable>
+cd <replaceable>my-fedora-docs-sandbox</replaceable>
+export CVSROOT=:ext:<replaceable>username</replaceable>@cvs.fedora.redhat.com:/cvs/docs
+cvs login
+cvs co docs-common</userinput>
+</screen>
+
+    <para>
+      At the password prompt, press the <keycap>Enter</keycap> key.
+    </para>
+
+    <note>
+      <title>Common Files</title>
+      <para>
+	You need to perform this "checkout" step only once, although you may
+	need to update the files later.  These files are common to all the
+	official documentation.
+      </para>
+    </note>
+
+    <para>
+      To work on existing documents in CVS, refer to <xref linkend="ch-cvs"/>.
+    </para>
+
+  </section>
+
+  <section id="ch-getting-files-filenames">
+    <title>Filename Conventions</title>
+    <para>
+      &FDP; provides the tools, scripts, and stylesheets to transform your
+      <abbrev>XML</abbrev> documents into other output formats such as
+      <abbrev>HTML</abbrev>.  In addition, these tools can build your document
+      into a <abbrev>RPM</abbrev> package.  To take advantage of these
+      services, you must follow conventions for naming your files.
+    </para>
+    <section id="ch-getting-files-filenames-doc">
+      <title>Document Filenames</title>
+      <para>
+        Each document lives in a peer directory to the
+        <filename>docs-common</filename> directory you extracted from the &FED;
+        archive earlier.  On the CVS server, these directories are called
+        <firstterm>modules</firstterm>.  Choose a module name that accurately
+        reflects your document's subject, but avoid any name already taken.  Use
+        the <command>cvs co -c</command> command to view existing module names.
+      </para>
+      <important>
+	<title>Avoid Redundancy</title>
+	<para>
+	  Do not use the word <wordasword>&FED;</wordasword> in your module
+	  name.  Since all documents in the repository are &FED; documentation,
+	  using this term creates unnecessary confusion.
+	</para>
+      </important>
+    </section>
+  </section>
+</chapter>
+
+<!--
+Local variables:
+mode: xml
+fill-column: 72
+End:
+-->