Fix quantum admin doc bugs.

bug 1056857 bug 1056872 bug 1056884 Change-Id: Ie77c1f0561d2abcb9deb72c8441cca12f490e497
openstack · Sep 26, 2012 · 0d7977e · 0d7977e
1 parent bf2f594
commit 0d7977e
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 92 deletions.
diff --git a/doc/src/docbkx/openstack-network-connectivity-admin/app_core.xml b/doc/src/docbkx/openstack-network-connectivity-admin/app_core.xml
@@ -6,33 +6,6 @@
 <!ENTITY hellip "&#x2026;">
 <!ENTITY plusmn "&#xB1;">
 
-<!-- Useful for describing APIs -->
-<!ENTITY GET    '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
-<!ENTITY PUT    '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
-<!ENTITY POST   '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
-<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
-
-<!ENTITY CHECK  '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
-<imageobject role="fo">
-<imagedata fileref="figures/Check_mark_23x20_02.svg"
-format="SVG" scale="60"/>
-</imageobject>
-<imageobject role="html">
-<imagedata fileref="../figures/Check_mark_23x20_02.png"
-format="PNG" />
-</imageobject>
-</inlinemediaobject>'>
-
-<!ENTITY ARROW  '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
-<imageobject role="fo">
-<imagedata fileref="figures/Arrow_east.svg"
-format="SVG" scale="60"/>
-</imageobject>
-<imageobject role="html">
-<imagedata fileref="../figures/Arrow_east.png"
-format="PNG" />
-</imageobject>
-</inlinemediaobject>'>
 ]>
 <appendix xmlns="http://docbook.org/ns/docbook"
     xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -41,7 +14,7 @@ format="PNG" />
     <title>Core Configuration File Options</title>
     <section xml:id="quantum_conf">
         <title>quantum.conf</title>
-        <para>
+        <para>The configuration settings for the quantum services are found in <filename>/etc/quantum/quantum.conf</filename>.</para>
             <table rules="all">
                 <caption>Debugging Options</caption>
                 <thead>
@@ -61,8 +34,9 @@ format="PNG" />
                         <td>(BoolOpt) Print more verbose output </td>
                     </tr>
                 </tbody>
-            </table>  </para>
-        <para><table rules="all">
+            </table>
+
+        <table rules="all">
                 <caption>Logging Options</caption>
                 <thead>
                     <tr>
@@ -116,8 +90,8 @@ format="PNG" />
                             lines </td>
                     </tr>
                 </tbody>
-            </table></para>
-        <para><table rules="all">
+            </table>
+       <table rules="all">
                 <caption>Service Options</caption>
                 <thead>
                     <tr>
@@ -166,8 +140,8 @@ format="PNG" />
                             service. </td>
                     </tr>
                 </tbody>
-            </table></para>
-        <para>
+            </table>
+
             <table rules="all">
                 <caption>Base Plugin Options</caption>
                 <thead>
@@ -219,8 +193,8 @@ format="PNG" />
                     </tr>
                 </tbody>
             </table>
-        </para>
-        <para>
+
+
             <table rules="all">
                 <caption>Common RPC Message Options</caption>
                 <thead>
@@ -271,8 +245,8 @@ format="PNG" />
                             provider </td>
                     </tr>
                 </tbody>
-            </table>  </para>
-        <para>
+            </table>
+
             <table rules="all">
                 <caption>Rabbit RPC Options</caption>
                 <thead>
@@ -339,8 +313,8 @@ format="PNG" />
                             interval </td>
                     </tr>
                 </tbody>
-            </table>  </para>
-        <para>
+            </table>
+
             <table rules="all">
                 <caption>QPID RPC Options</caption>
                 <thead>
@@ -420,8 +394,7 @@ format="PNG" />
                     </tr>
                 </tbody>
             </table>
-        </para>
-        <para>  <table rules="all">
+            <table rules="all">
                 <caption>Notification Options</caption>
                 <thead>
                     <tr>
@@ -460,8 +433,8 @@ format="PNG" />
                             notifications </td>
                     </tr>
                 </tbody>
-            </table>  </para>
-        <para>
+            </table>
+
             <table rules="all">
                 <caption>Quota Options</caption>
                 <thead>
@@ -508,7 +481,7 @@ format="PNG" />
                             tenant, and minus means unlimited </td>
                     </tr>
                 </tbody>
-            </table>   </para>
+            </table>
     </section>
     <section xml:id="ovs_quantum_plugin">
         <title>ovs_quantum_plugin.ini:</title>

diff --git a/doc/src/docbkx/openstack-network-connectivity-admin/bk-quantum-admin-guide.xml b/doc/src/docbkx/openstack-network-connectivity-admin/bk-quantum-admin-guide.xml
@@ -17,7 +17,7 @@
     version="5.0"
     status="final"
     xml:id="Quantum-admin-guide">
-    <?rax pdf.url="../quantum-admin-guide-trunk.pdf"?>
+    <?rax pdf.url="../bk-quantum-admin-guide-trunk.pdf"?>
     <title>OpenStack Quantum Administration Guide</title>
     <info>
         <author>

diff --git a/doc/src/docbkx/openstack-network-connectivity-admin/ch_install.xml b/doc/src/docbkx/openstack-network-connectivity-admin/ch_install.xml
@@ -6,47 +6,13 @@
 <!ENTITY hellip "&#x2026;">
 <!ENTITY plusmn "&#xB1;">
 
-<!-- Useful for describing APIs -->
-<!ENTITY GET    '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
-<!ENTITY PUT    '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
-<!ENTITY POST   '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
-<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
-
-<!ENTITY CHECK  '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
-<imageobject role="fo">
-<imagedata fileref="figures/Check_mark_23x20_02.svg"
-format="SVG" scale="60"/>
-</imageobject>
-<imageobject role="html">
-<imagedata fileref="../figures/Check_mark_23x20_02.png"
-format="PNG" />
-</imageobject>
-</inlinemediaobject>'>
-
-<!ENTITY ARROW  '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
-<imageobject role="fo">
-<imagedata fileref="figures/Arrow_east.svg"
-format="SVG" scale="60"/>
-</imageobject>
-<imageobject role="html">
-<imagedata fileref="../figures/Arrow_east.png"
-format="PNG" />
-</imageobject>
-</inlinemediaobject>'>
-<!ENTITY SENova 'services extension'>
-<!ENTITY uSENova 'Services extension'>
-<!ENTITY uuSENova 'Services Extension'>
-<!ENTITY RSNova 'reset state extension'>
-<!ENTITY uRSNova 'Reset state extension'>
-<!ENTITY uuRSNova 'Reset State Extension'>
-<!ENTITY ngCS 'next generation Rackspace Cloud Servers™ <link
-                        xlink:href="http://www.rackspace.com/cloud/openstack/"
-                        >powered by OpenStack</link>'>
-<!ENTITY ungCS 'Next generation Rackspace Cloud Servers™ <link
-                        xlink:href="http://www.rackspace.com/cloud/openstack/"
-                        >powered by OpenStack</link>'>
 ]>
-<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="ch_install">
+<chapter 
+    xmlns="http://docbook.org/ns/docbook" 
+    xmlns:xi="http://www.w3.org/2001/XInclude" 
+    xmlns:xlink="http://www.w3.org/1999/xlink" 
+    version="5.0" 
+    xml:id="ch_install">
     <title>Quantum Installation</title>
     <para> This chapter describes how to install the Quantum Service
         and get it up and running. </para>
@@ -83,12 +49,12 @@ apt-get update &amp;&amp; apt-get dist-upgrade</computeroutput></screen>
                 existing RabbitMQ setup is sufficient):  </para>
             <screen><computeroutput>apt-get install rabbitmq-server   
 rabbitmqctl change_password guest &lt;password&gt;</computeroutput></screen>
-            <para>Then update quantum.conf with these values: </para>
+            <para>Then update /etc/quantum/quantum.conf with these values: </para>
             <screen><computeroutput>rabbit_host=&lt;mgmt-IP-of-rabbit-host&gt;
 rabbit_password=&lt;password&gt;
 rabbit_user=guest </computeroutput></screen>
             <important>
-                <para>This quantum.conf file should be copied to and
+                <para>This /etc/quantum/quantum.conf file should be copied to and
                     used on all hosts running quantum-server,
                     quantum-dhcp-agent, quantum-openvswitch-agent, or
                     quantum-linuxbridge-agent (see below). </para>
@@ -126,7 +92,7 @@ rabbit_user=guest </computeroutput></screen>
             </note>
             <section xml:id="openvswitch_plugin">
             <title>Configuring Open vSwitch Plugin</title>
-            <para>Using the OVS plugin in a deployment with multiple
+            <para>Using the Open vSwitch (OVS) plugin in a deployment with multiple
                 hosts requires the using of either tunneling or vlans
                 in order to isolate traffic from multiple networks. 
                 Tunneling is easier to deploy, as it does not require
@@ -211,8 +177,8 @@ service quantum-server stop
 service quantum-server status
 service quantum-server start
 service quantum-server restart</computeroutput></screen>
-    <para> Log files are found in /var/log/quantum . </para>
-    <para> Configuration files are in /etc/quantum . </para>
+    <para> Log files are found in /var/log/quantum. </para>
+    <para> Configuration files are in /etc/quantum. </para>
         </section>
     </section>
     <section xml:id="install_fedora">

diff --git a/doc/src/docbkx/openstack-network-connectivity-admin/pom.xml b/doc/src/docbkx/openstack-network-connectivity-admin/pom.xml
@@ -57,7 +57,7 @@
             <plugin>
                 <groupId>com.rackspace.cloud.api</groupId>
                 <artifactId>clouddocs-maven-plugin</artifactId>
-                <version>1.4.0</version>
+                <version>1.5.0</version>
                 <executions>
                     <execution>
                         <id>goal1</id>