[documentation-guide] Updated the Publican preparation section

Eric Christensen sparks at fedoraproject.org
Sun Jun 12 19:37:17 UTC 2011


commit 14a76886214b18e39442724743f13106f0bd5a73
Author: Eric H Christensen <eric at christensenplace.us>
Date:   Sun Jun 12 12:16:21 2011 -0400

    Updated the Publican preparation section

 en-US/publican.xml |   38 +++++++++++++++++++++++---------------
 1 files changed, 23 insertions(+), 15 deletions(-)
---
diff --git a/en-US/publican.xml b/en-US/publican.xml
index 80f7750..d066598 100644
--- a/en-US/publican.xml
+++ b/en-US/publican.xml
@@ -32,26 +32,34 @@
                         <title>Publishing a Document to the Web</title>
 			<para>Publishing a document to the Fedora Documentation website isn't that difficult when <application>Publican</application> is doing the heavy lifting.  It is assumed that you already have the repository cloned on the computer that <application>Publican</application> will be working from and that your configuration is complete.</para>
 			<warning><para>Documents produced with versions of Publican prior to 2.5 are not compatible with the current website structure. Always make sure that you have the latest version of Publican installed before you publish documents.</para></warning>
-			<para>The following procedure should create four formats of your document and upload those formatted files to the Fedora Documentation website.</para>
-	<itemizedlist><listitem><para>Create a local copy of the git repository of the docs.fedoraproject.org website:
-<command>git clone ssh://USERNAME@git.fedorahosted.org/git/docs/web.git</command>
-Where '''''USERNAME''''' is your FAS username.
-{{admon/note | Large download | This download will take some time, even on fast connections.}}</para></listitem>
-<listitem><para>Change into the directory into which you downloaded the '''web.git''' repo, and make a copy of '''homepage.tmp''' named '''homepage.cfg''':
-<command>cp homepage.tmp homepage.cfg</command></para></listitem>
-<listitem><para>Edit the '''homepage.cfg''' file to provide the absolute paths to the '''fedoradocs.db''' file and the '''public_html''' directory. For example, if you downloaded the '''web.git''' repo to the '''fedoradocs''' subdirectory of your home directory, your homepage.cfg file might look like:
-<command># Config::Simple 4.59
-# Tue May 11 13:53:03 2010
+
+			<section id="chap-documentation_guide-publican-workflow-Publishing_to_web-Getting_setup">
+				<title>Preparing your system</title>
+				<para>Before we start building your documents into the proper formats for user consumption we need to pull down the webpage source which you'll later add your document into and commit.  The following procedure will instruct you on how to do this.</para>
+				<itemizedlist>
+					<listitem>
+					<para>Create a local copy of the git repository of the docs.fedoraproject.org website: <command>git clone ssh://USERNAME@git.fedorahosted.org/git/docs/web.git</command> where <literal>USERNAME</literal> is your FAS username.
+<notice><para>This download will take some time, even on fast connections.</para></notice>
+					</listitem>
+					<listitem>
+					<para>Change into the directory into which you downloaded the <literal>web.git</literal> repo, and make a copy of <literal>homepage.tmp</literal> named <literal>homepage.cfg</literal>:<command>cp homepage.tmp homepage.cfg</command></para>
+					</listitem>
+					<listitem>
+					<para>Edit the <literal>homepage.cfg</literal> file to provide the absolute paths to the <literal>fedoradocs.db</literal> file and the <literal>public_html</literal> directory. For example, if you downloaded the <literal>web.git</literal> repo to the <literal>fedoradocs</literal> subdirectory of your home directory, your homepage.cfg file might look like: <command>
+
+# Config::Simple 4.59 # Tue May 11 13:53:03 2010
 
 db_file: /home/jsmith/fedoradocs/web/fedoradocs.db
 toc_path: /home/jsmith/fedoradocs/web/public_html
 host: http://docs.fedoraproject.org
 title: "Fedora Documentation"
-search: '<p/>'</command></para></listitem>
-<listitem><para>Make sure you have the latest version of Publican and the Fedora brand package. As root, run:
-<command>yum update publican publican-fedora</command>
-</para></listitem></itemizedlist>
-
+search: '<p/>'</command></para>
+					</listitem>
+					<listitem>
+					<para>Make sure you have the latest version of Publican and the Fedora brand package. As root, run: <command>yum update publican publican-fedora</command></para>
+					</listitem>
+				</itemizedlist>
+			</section>
 
 ==Publishing a document==
 {{admon/warning|Publican now controls the directory structure and the SQLite database that manages the site and its tables of contents. Do not add or remove directories from the directory tree manually as we did in the past.}}


More information about the docs-commits mailing list