[documentation-guide] Publicanized more wiki text

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


commit fcb5638a15f919bc3b0c3f97f97fd107bd6dba26
Author: Eric H Christensen <eric at christensenplace.us>
Date:   Sun Jun 12 12:01:49 2011 -0400

    Publicanized more wiki text

 en-US/publican.xml |   76 ++++++++++++++++++++++++++--------------------------
 1 files changed, 38 insertions(+), 38 deletions(-)
---
diff --git a/en-US/publican.xml b/en-US/publican.xml
index e25baeb..80f7750 100644
--- a/en-US/publican.xml
+++ b/en-US/publican.xml
@@ -33,25 +33,25 @@
 			<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>
-<!--
-<ol><li>Create a local copy of the git repository of the docs.fedoraproject.org website:
-<pre>git clone ssh://USERNAME@git.fedorahosted.org/git/docs/web.git</pre>
+	<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.}}</li>
-<li>Change into the directory into which you downloaded the '''web.git''' repo, and make a copy of '''homepage.tmp''' named '''homepage.cfg''':
-<pre>cp homepage.tmp homepage.cfg</pre></li>
-<li>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:
-<pre># Config::Simple 4.59
+{{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
 
 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/>'</pre></li>
-<li>Make sure you have the latest version of Publican and the Fedora brand package. As root, run:
-<pre>yum update publican publican-fedora</pre>
-</li></ol>
+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>
+
 
 ==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.}}
@@ -60,49 +60,49 @@ search: '<p/>'</pre></li>
 
 
 
-<ol><li>Update your copy of the docs.fedoraproject.org website. In the directory where you keep your local copy of the site, run:
-<pre>git pull</pre></li>
+<itemizedlist><listitem><para>Update your copy of the docs.fedoraproject.org website. In the directory where you keep your local copy of the site, run:
+<command>git pull</command></para></listitem>
 
-<li>Change to the directory where you keep a checked-out copy of the document that you want to publish, then run:
-<pre>publican build -- embedtoc -- publish -- formats epub,html,html-single,pdf -- langs LANGUAGE_CODES</pre>
-where '''''LANGUAGE_CODES''''' is a comma-separated list of the languages in which you want to publish this document. </li>
+<listitem><para>Change to the directory where you keep a checked-out copy of the document that you want to publish, then run:
+<command>publican build -- embedtoc -- publish -- formats epub,html,html-single,pdf -- langs LANGUAGE_CODES</command>
+where '''''LANGUAGE_CODES''''' is a comma-separated list of the languages in which you want to publish this document. </para></listitem>
 
-<li>Browse to the '''publish''' subdirectory and to the documents themselves inside it to ensure that the documents have built as you expected. In particular, verify:
+<listitem><para>Browse to the '''publish''' subdirectory and to the documents themselves inside it to ensure that the documents have built as you expected. In particular, verify:
 * the product name is '''Fedora''' (note capitalization)
 * the version number is correct
-* the document title is properly capitalized and spaced: for example, '''Foo Guide''', not '''foo-guide'''</li>
+* the document title is properly capitalized and spaced: for example, '''Foo Guide''', not '''foo-guide'''</para></listitem>
 
-<li>Install the book to the Fedora website:
-<pre>publican install_book --site_config PATH_TO_SITE_CONFIG_FILE --lang LANGUAGE_CODE</pre>
-where '''''PATH_TO_SITE_CONFIG_FILE''''' is the path to the '''homepage.cfg''' file in your local copy of the docs.fedoraproject.org website, and '''''LANGUAGE_CODE''''' is the language in which you are publishing the document. Note that you can only run '''publican&nbsp;install_book''' for one language at a time.</li>
+<listitem><para>Install the book to the Fedora website:
+<command>publican install_book --site_config PATH_TO_SITE_CONFIG_FILE --lang LANGUAGE_CODE</command>
+where '''''PATH_TO_SITE_CONFIG_FILE''''' is the path to the '''homepage.cfg''' file in your local copy of the docs.fedoraproject.org website, and '''''LANGUAGE_CODE''''' is the language in which you are publishing the document. Note that you can only run '''publican&nbsp;install_book''' for one language at a time.</para></listitem>
 
-<li>Change to the directory in which you keep your local copy of the site and run:
-<pre>git add .
+<listitem><para>Change to the directory in which you keep your local copy of the site and run:
+<command>git add .
 git commit -m "DESCRIPTION_OF_YOUR_CHANGES"
-git push</pre></li></ol>
+git push</command></para></listitem></itemizedlist>
 
 ==Removing a document==
 To remove a document for a particular version of Fedora in a particular language:
 
-<ol><li>Update your copy of the docs.fedoraproject.org website. In the directory where you keep your local copy of the site, run:
-<pre>git pull</pre></li>
+<itemizedlist><listitem><para>Update your copy of the docs.fedoraproject.org website. In the directory where you keep your local copy of the site, run:
+<command>git pull</command></para></listitem>
 
-<li>Change to the directory where you keep a checked-out copy of the document that you want to remove, then run:
-<pre>publican remove_book --site_config PATH_TO_SITE_CONFIG_FILE --lang LANGUAGE_CODE</pre>
+<listitem><para>Change to the directory where you keep a checked-out copy of the document that you want to remove, then run:
+<command>publican remove_book --site_config PATH_TO_SITE_CONFIG_FILE --lang LANGUAGE_CODE</command>
 
-where '''''PATH_TO_SITE_CONFIG_FILE''''' is the path to the '''homepage.cfg''' file in your local copy of the docs.fedoraproject.org website, and '''''LANGUAGE_CODE''''' is the language in which you are removing the document. Note that you can only run '''publican&nbsp;remove_book''' for one language at a time.</li>
+where '''''PATH_TO_SITE_CONFIG_FILE''''' is the path to the '''homepage.cfg''' file in your local copy of the docs.fedoraproject.org website, and '''''LANGUAGE_CODE''''' is the language in which you are removing the document. Note that you can only run '''publican&nbsp;remove_book''' for one language at a time.</para></listitem>
 
-<li>Change to the directory in which you keep your local copy of the site and run:
-<pre>git add .
+<listitem><para>Change to the directory in which you keep your local copy of the site and run:
+<command>git add .
 git commit -m "DESCRIPTION_OF_YOUR_CHANGES"
-git push</pre></li>
+git push</command></para></listitem>
 
-<li>Publican can only remove the local files and directories on your system, not their record in Git. To remove the deleted files from your local Git repo, run:
-<pre>for f in $(git ls-files --deleted); do git rm $f; done </pre>
+	<listitem><para>Publican can only remove the local files and directories on your system, not their record in Git. To remove the deleted files from your local Git repo, run:
+<command>for f in $(git ls-files --deleted); do git rm $f; done </command>
 Then push these changes to the remote repo:
-<pre>git commit -m"rm unused files"
-git push</pre>
-{{admon/warning|A "git rm" command gone wrong can cause widespread damage to the documentation site. If you are not absolutely sure of what you are doing, ask for help.}}</li></ol>
+<command>git commit -m"rm unused files"
+git push</command>
+{{admon/warning|A "git rm" command gone wrong can cause widespread damage to the documentation site. If you are not absolutely sure of what you are doing, ask for help.}}</para></listitem></itemizedlist>
 
 ==Updating a document==
 To update a document previously published in a particular language for a particular version of Fedora, change into the directory in which you keep a checked-out copy of the document, then run '''publican install_book''', as if you were installing it for the first time. Publican automatically replaces the old version with the new one.


More information about the docs-commits mailing list