[documentation-guide] Updated the Publican publishing instructions
Eric Christensen
sparks at fedoraproject.org
Sun Jun 12 19:37:27 UTC 2011
commit 58315da2d000ffb26802735187ed9f0bb01c97a9
Author: Eric H Christensen <eric at christensenplace.us>
Date: Sun Jun 12 12:34:07 2011 -0400
Updated the Publican publishing instructions
en-US/publican.xml | 37 +++++++++++++++----------------------
1 files changed, 15 insertions(+), 22 deletions(-)
---
diff --git a/en-US/publican.xml b/en-US/publican.xml
index 78d6d9a..a09bdc6 100644
--- a/en-US/publican.xml
+++ b/en-US/publican.xml
@@ -78,34 +78,27 @@ git commit -m "DESCRIPTION_OF_YOUR_CHANGES"
git push</command></para></listitem>
</itemizedlist>
</section>
-==Removing a document==
-To remove a document for a particular version of Fedora in a particular language:
-
-<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:
+ <section id="chap-documentation_guide-publican-workflow-Removing_a_document">
+ <title>Removing a document from the Web</title>
+ <para>To remove a document for a particular version of Fedora in a particular language:</para>
+ <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 '''''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 remove_book''' 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:
-<command>for f in $(git ls-files --deleted); do git rm $f; done </command>
-Then push these changes to the remote repo:
+ <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>
-{{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>
+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>
-==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.
--->
+ <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.
</section>
-
</section>
</chapter>
<!-- Outline for this chapter.
More information about the docs-commits
mailing list