[documentation-guide] Updated the Publican publishing instructions

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


commit 517dda76795a63a5a143c3cd9b67158c0026bda5
Author: Eric H Christensen <eric at christensenplace.us>
Date:   Sun Jun 12 12:26:38 2011 -0400

    Updated the Publican publishing instructions

 en-US/publican.xml |   43 ++++++++++++++++---------------------------
 1 files changed, 16 insertions(+), 27 deletions(-)
---
diff --git a/en-US/publican.xml b/en-US/publican.xml
index d066598..78d6d9a 100644
--- a/en-US/publican.xml
+++ b/en-US/publican.xml
@@ -60,35 +60,24 @@ search: '<p/>'</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.}}
-{{admon/warning|If you are publishing draft documentation, be sure to follow the instructions described at [[Publishing draft documentation]] first.}}
-{{admon/warning|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_using_Publican|Unpublishing draft documentation]] first.}}
-
-
-
-<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 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>
-
-<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'''</para></listitem>
-
-<listitem><para>Install the book to the Fedora website:
+			<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 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>
+				</listitem>
+				<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 <literal>LANGUAGE_CODES</literal> is a comma-separated list of the languages in which you want to publish this document.</para></listitem>
+				<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 <literal>Fedora</literal> (note capitalization), the version number is correct, the document title is properly capitalized and spaced: for example, <literal>Foo Guide</literal>, not <literal>foo-guide</literal></para></listitem>
+				<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>
-
-<listitem><para>Change to the directory in which you keep your local copy of the site and run:
-<command>git add .
+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 publishing the document. Note that you can only run <command>publican install_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></itemizedlist>
-
+git push</command></para></listitem>
+				</itemizedlist>
+			</section>
 ==Removing a document==
 To remove a document for a particular version of Fedora in a particular language:
 


More information about the docs-commits mailing list