Added Complete Doc conventions in user-guide.

Change-Id: Ibbc5cd3be6343a05a0537508f6e580a597447af4 Partial-Bug: #1121866
openstack · Dec 10, 2013 · 3714af4 · 3714af4
1 parent 632a917
commit 3714af4
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 28 deletions.
diff --git a/doc/user-guide/ch_dashboard.xml b/doc/user-guide/ch_dashboard.xml
@@ -7,7 +7,7 @@
     xmlns:raxm="http://docs.rackspace.com/api/metadata" version="5.0"
     xml:id="ch_dashboard">
     <info>
-        <title>OpenStack dashboard</title>
+        <title>Dashboard</title>
     </info>
     <para>As a cloud end user, you can use the OpenStack dashboard to
         provision your own resources within the limits set by

diff --git a/doc/user-guide/section_ceilometer_cli.xml b/doc/user-guide/section_ceilometer_cli.xml
@@ -6,7 +6,7 @@
     xmlns:html="http://www.w3.org/1999/xhtml" version="5.0"
     xml:id="ceilometer_cli_commands">
     <title>Measure cloud resources</title>
-    <para>The Telemetry service measures cloud resources within
+    <para>The OpenStack Telemetry service measures cloud resources within
         OpenStack.</para>
     <para>It collects information about how much, who, what, and when
         with regards to billing. For Havana, metering is available

diff --git a/doc/user-guide/section_dashboard_access_and_security.xml b/doc/user-guide/section_dashboard_access_and_security.xml
@@ -28,10 +28,9 @@
         <title>Add rules to the default security group</title>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
-                    project, and click the
-                        <guilabel>Access &amp; Security</guilabel> category. The
-                    dashboard shows the security groups that are
+                <para>Log in to the dashboard, choose a project, and click the
+                        <guilabel>Access &amp; Security</guilabel> category.
+                    The dashboard shows the security groups that are
                     available for this project.</para>
             </step>
             <step>
@@ -119,7 +118,7 @@
         <para>Create at least one keypair for each project.</para>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the <guilabel>Access &amp;
                         Security</guilabel> category.</para>
             </step>
@@ -147,7 +146,7 @@
         <title>Import a keypair</title>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the <guilabel>Access &amp;
                         Security</guilabel> category.</para>
             </step>

diff --git a/doc/user-guide/section_dashboard_create_networks.xml b/doc/user-guide/section_dashboard_create_networks.xml
@@ -13,8 +13,8 @@
     <?dbhtml stop-chunking?>
     <procedure>
         <step>
-            <para>Log in to the OpenStack dashboard, choose a project,
-                and, click the <guibutton>Networks</guibutton>
+            <para>Log in to the dashboard, choose a project,
+                and click the <guibutton>Networks</guibutton>
                 category.</para>
         </step>
         <step>

diff --git a/doc/user-guide/section_dashboard_launch_instances.xml b/doc/user-guide/section_dashboard_launch_instances.xml
@@ -78,7 +78,7 @@
             instances.</para>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the
                         <guilabel>Overview</guilabel> category.</para>
             </step>
@@ -97,7 +97,7 @@
         <title>Create instance snapshots</title>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the
                         <guilabel>Instances</guilabel>
                     category.</para>
@@ -129,7 +129,7 @@
         <title>Manage an instance</title>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the
                         <guilabel>Instances</guilabel>
                     category.</para>

diff --git a/doc/user-guide/section_dashboard_launch_instances_from_image.xml b/doc/user-guide/section_dashboard_launch_instances_from_image.xml
@@ -16,7 +16,7 @@
         instance starts.</para>
     <procedure>
         <step>
-            <para>Log in to the OpenStack dashboard, choose a project,
+            <para>Log in to the dashboard, choose a project,
                 and click the <guilabel>Images &amp;
                     Snapshot</guilabel> category.</para>
             <para>The dashboard shows the images that have been

diff --git a/doc/user-guide/section_dashboard_manage_images.xml b/doc/user-guide/section_dashboard_manage_images.xml
@@ -19,7 +19,7 @@
       Guide</citetitle></link>.</para>
     <procedure>
       <step>
-        <para>Log in to the OpenStack dashboard.</para>
+        <para>Log in to the dashboard.</para>
         <para>Choose the <guilabel>admin</guilabel> project from the
             <guilabel>CURRENT PROJECT</guilabel> drop-down
           list.</para>
@@ -103,7 +103,7 @@
     <title>Update images</title>
     <procedure>
       <step>
-        <para>Log in to the OpenStack dashboard.</para>
+        <para>Log in to the dashboard.</para>
         <para>Choose the <guilabel>admin</guilabel> project from the
             <guilabel>CURRENT PROJECT</guilabel> drop-down
           list.</para>
@@ -134,7 +134,7 @@
     <title>Delete images</title>
     <procedure>
       <step>
-        <para>Log in to the OpenStack dashboard.</para>
+        <para>Log in to the dashboard.</para>
         <para>Choose the <guilabel>admin</guilabel> project from the
             <guilabel>CURRENT PROJECT</guilabel> drop-down
           list.</para>

diff --git a/doc/user-guide/section_dashboard_manage_volumes.xml b/doc/user-guide/section_dashboard_manage_volumes.xml
@@ -23,8 +23,8 @@
         <procedure>
             <!-- <title>To create or delete a volume</title> -->
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
-                    project, and, click the
+                <para>Log in to the dashboard, choose a
+                    project, and click the
                         <guibutton>Volumes</guibutton>
                     category.</para>
             </step>
@@ -53,7 +53,7 @@
         <procedure>
             <!--<title>To attach volumes to instances</title>-->
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the
                         <guibutton>Volumes</guibutton>
                     category.</para>
@@ -96,7 +96,7 @@
         <title>Detach a volume from an instance</title>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the
                         <guibutton>Volumes</guibutton>
                     category.</para>
@@ -119,7 +119,7 @@
         <title>Create volume snapshots</title>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the <guilabel>Instances &amp;
                         Volumes</guilabel> category.</para>
             </step>
@@ -150,7 +150,7 @@
             volumes is not destroyed.</para>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
+                <para>Log in to the dashboard, choose a
                     project, and click the
                         <guibutton>Volumes</guibutton>
                     category.</para>

diff --git a/doc/user-guide/section_dashboard_stacks.xml b/doc/user-guide/section_dashboard_stacks.xml
@@ -25,8 +25,8 @@
         <title>Launch a stack</title>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard, choose a
-                    project, and, click <guibutton>Stacks</guibutton>
+                <para>Log in to the dashboard, choose a
+                    project, and click <guibutton>Stacks</guibutton>
                     in the <guilabel>Orchestration</guilabel>
                     category.</para>
             </step>
@@ -163,7 +163,7 @@
         <title>Delete stacks</title>
         <procedure>
             <step>
-                <para>Log in to the OpenStack dashboard.</para>
+                <para>Log in to the dashboard.</para>
             </step>
             <step>
                 <para>On the <guilabel>Project</guilabel> tab, click

diff --git a/doc/user-guide/section_nova_cli_config-drive.xml b/doc/user-guide/section_nova_cli_config-drive.xml
@@ -136,7 +136,7 @@
                 <programlisting language="ini">force_config_drive=true</programlisting>
                 <note>
                     <para>If a user passes the
-                            <literal>--config-drive=true</literal>
+                            <parameter>--config-drive=true</parameter>
                         flag to the <command>nova boot</command>
                         command, an administrator cannot disable the
                         configuration drive.</para>

diff --git a/doc/user-guide/section_swift_cli_howto.xml b/doc/user-guide/section_swift_cli_howto.xml
@@ -4,7 +4,7 @@
     xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
     xml:id="managing-openstack-object-storage-with-swift-cli">
     <title>Manage objects and containers</title>
-    <para>The Object Storage service provides the
+    <para>The OpenStack Object Storage Service provides the
             <command>swift</command> client, which is a command-line
         interface (CLI). Use this client to list objects and
         containers, upload objects to containers, and download or