[documentation-guide] Fixed some tagging errors
Eric Christensen
sparks at fedoraproject.org
Sun Jun 12 19:37:32 UTC 2011
commit 5a35db1c0b2d9cce16a1278216375e80334f4817
Author: Eric H Christensen <eric at christensenplace.us>
Date: Sun Jun 12 13:07:36 2011 -0400
Fixed some tagging errors
en-US/publican.xml | 54 +++++++++++++++++++++++++--------------------------
1 files changed, 26 insertions(+), 28 deletions(-)
---
diff --git a/en-US/publican.xml b/en-US/publican.xml
index a09bdc6..0b77bfe 100644
--- a/en-US/publican.xml
+++ b/en-US/publican.xml
@@ -1,12 +1,11 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "documentation-guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "Documentation_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-documentation_guide-publican">
<title>Publican</title>
- <para>
- <application>Publican</application> is a program that creates the end product that our customers see. The program creates html, html-single, PDF, and ePub formatted files from DocBook XML source code. The files that Publican builds can then be uploaded to a website or packaged in an RPM.
+ <para><application>Publican</application> is a program that creates the end product that our customers see. The program creates html, html-single, PDF, and ePub formatted files from DocBook XML source code. The files that Publican builds can then be uploaded to a website or packaged in an RPM.
</para>
<section id="chap-documentation_guide-publican-workflow">
<title>Publican Workflow</title>
@@ -33,37 +32,35 @@
<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>
- <section id="chap-documentation_guide-publican-workflow-Publishing_to_web-Getting_setup">
- <title>Preparing your system</title>
+ <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.
+ <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.</para>
<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
+ </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>
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>
+search:</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>
<section id="chap-documentation_guide-publican-workflow-Publishing_a_Document">
<title>Publishing a Document</title>
<warning><para>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.</para></warning>
- <warning><para>If you are publishing draft documentation, be sure to follow the instructions described at [[Publishing draft documentation]] first.</para></warning>
+ <warning><para>If you are publishing draft documentation, be sure to follow the instructions described at Publishing draft documentation first.</para></warning>
<warning><para>If you are publishing the final version of documentation that was first published in the "Draft Documentation" category, be sure to follow the instructions described at Unpublishing draft documentation first.</para></warning>
<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>
@@ -84,20 +81,21 @@ git push</command></para></listitem>
<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>
- <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 <literal>PATH_TO_SITE_CONFIG_FILE</literal> is the path to the <literal>homepage.cfg</literal> file in your local copy of the docs.fedoraproject.org website, and <literal>LANGUAGE_CODE</literal> is the language in which you are removing the document. Note that you can only run <command>publican remove_book</command> for one language at a time.</para></listitem>
- <listitem><para>Change to the directory in which you keep your local copy of the site and run: <command>git add .
+ <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 <literal>PATH_TO_SITE_CONFIG_FILE</literal> is the path to the <literal>homepage.cfg</literal> file in your local copy of the docs.fedoraproject.org website, and <literal>LANGUAGE_CODE</literal> is the language in which you are removing the document. Note that you can only run <command>publican remove_book</command> for one language at a time.</para></listitem>
+ <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</command></para></listitem>
- <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:
+ <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:
<command>git commit -m"rm unused files"
git push</command></para>
<warning><para>A <command>git rm</command> 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></warning></listitem></itemizedlist>
-
- <section id="chap-documentation_guide-publican-workflow-Updating_a_Document">
+ </section>
+ <section id="chap-documentation_guide-publican-workflow-Updating_a_Document">
<title>Updating a Document</title>
- <para>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 <command>publican install_book</command>, as if you were installing it for the first time. Publican automatically replaces the old version with the new one.
+ <para>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 <command>publican install_book</command>, as if you were installing it for the first time. Publican automatically replaces the old version with the new one.</para>
+ </section>
</section>
</section>
</chapter>
More information about the docs-commits
mailing list