[documentation-guide] More fixes
Eric Christensen
sparks at fedoraproject.org
Sun Jun 12 19:37:38 UTC 2011
commit 4a968e7ecbc0eed75ddb892eb012608be18c89f8
Author: Eric H Christensen <eric at christensenplace.us>
Date: Sun Jun 12 15:36:37 2011 -0400
More fixes
en-US/publican.xml | 15 ++++-----------
1 files changed, 4 insertions(+), 11 deletions(-)
---
diff --git a/en-US/publican.xml b/en-US/publican.xml
index 0b77bfe..fab1125 100644
--- a/en-US/publican.xml
+++ b/en-US/publican.xml
@@ -16,7 +16,6 @@
<para>Creating a new book or article is easy using this command: <command>publican create --name=<replaceable>Book_Name</replaceable> --brand=fedora --lang=<replaceable>language identifier</replaceable> --type=book <replaceable>or</replaceable> article.</command> This string will create a new directory with the same name as <literal>Book_Name</literal>, with a directory of the language identifier inside the <literal>Book_Name</literal> directory. Also created is a publican.cfg configuration file that handles some <application>Publican</application> configuration switches.</para>
<para>The type of document can be a bit confusing. The type <literal>article</literal> is best used for documents that will be five pages or less. <literal>Book</literal> on the other hand is best for documents that are longer than five pages and includes a title page, preface, and an index, among other differences.</para>
</section>
-<!-- This text needs to be fleshed out.
<section id="chap-documentation_guide-publican-workflow-validating_XML">
<title>Validating XML Code</title>
<para></para>
@@ -26,7 +25,6 @@
<title>Building a document</title>
<para></para>
</section>
--->
<section id="chap-documentation_guide-publican-workflow-Publishing_to_web">
<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>
@@ -44,15 +42,13 @@
<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>
-
+ <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:</command></para>
--->
- </listitem>
+ </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>
@@ -86,10 +82,7 @@ git push</command></para></listitem>
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:
-<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>
+<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>
<section id="chap-documentation_guide-publican-workflow-Updating_a_Document">
@@ -98,7 +91,6 @@ git push</command></para>
</section>
</section>
</section>
-</chapter>
<!-- Outline for this chapter.
Introduction to Publican
** Toolchain that makes it easier to deal with DocBook
@@ -123,3 +115,4 @@ Introduction to Publican
** Tips and Tricks
*** Marking docs as draft
-->
+</chapter>
More information about the docs-commits
mailing list