Move command references from section to chapters

Rename sections to chapters for the command references.

Update cli-reference to remove single "command references" chapter and
add a chapter per command.

Adjust training-guides.

Change-Id: I64b30bca4915eed4f312bb3d2b5692c11b19fc81
This commit is contained in:
Andreas Jaeger 2014-01-31 20:59:54 +01:00 committed by Gerrit Code Review
parent bd66a34d3d
commit b7ed9d3dfe
14 changed files with 29 additions and 54 deletions

View File

@ -55,8 +55,13 @@
<xi:include href="ch_preface.xml"/> <xi:include href="ch_preface.xml"/>
<xi:include href="ch_cli.xml"/> <xi:include href="ch_cli.xml"/>
<xi:include href="ch_command_reference.xml"/> <xi:include href="../common/ch_cli_keystone_commands.xml"/>
<!-- Alternative 2 --> <xi:include href="../common/ch_cli_glance_commands.xml"/>
<!-- <xi:include href="ch_nova_cli.xml"/> --> <xi:include href="../common/ch_cli_neutron_commands.xml"/>
<xi:include href="../common/ch_cli_nova_commands.xml"/>
<xi:include href="../common/ch_cli_cinder_commands.xml"/>
<xi:include href="../common/ch_cli_swift_commands.xml"/>
<xi:include href="../common/ch_cli_heat_commands.xml"/>
<xi:include href="../common/ch_cli_ceilometer_commands.xml"/>
<xi:include href="../common/app_support.xml"/> <xi:include href="../common/app_support.xml"/>
</book> </book>

View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<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_command_reference">
<title>Command reference</title>
<xi:include
href="../common/section_cli_keystone_commands.xml"/>
<?hard page-break?>
<xi:include
href="../common/section_cli_glance_commands.xml"/>
<?hard page-break?>
<xi:include
href="../common/section_cli_neutron_commands.xml"/>
<?hard page-break?>
<xi:include
href="../common/section_cli_nova_commands.xml"/>
<?hard page-break?>
<xi:include
href="../common/section_cli_cinder_commands.xml"/>
<?hard page-break?>
<xi:include
href="../common/section_cli_swift_commands.xml"/>
<?hard page-break?>
<xi:include
href="../common/section_cli_heat_commands.xml"/>
<?hard page-break?>
<xi:include
href="../common/section_cli_ceilometer_commands.xml"/>
</chapter>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ceilometerclient_commands"> xml:id="ceilometerclient_commands">
@ -1645,4 +1645,4 @@ List trait all traits with name &lt;trait_name&gt; for Event Type &lt;event_type
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </chapter>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="cinderclient_commands"> xml:id="cinderclient_commands">
@ -2368,4 +2368,4 @@ Upload volume to image service as image.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </chapter>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="glanceclient_commands"> xml:id="glanceclient_commands">
@ -1143,4 +1143,4 @@ Describe sharing permissions by image or tenant.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </chapter>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="heatclient_commands"> xml:id="heatclient_commands">
@ -923,4 +923,4 @@ Validate a template with parameters.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </chapter>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="keystoneclient_commands"> xml:id="keystoneclient_commands">
@ -1383,4 +1383,4 @@ Update user's name, email, and enabled status.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </chapter>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="neutronclient_commands"> xml:id="neutronclient_commands">
@ -10593,4 +10593,4 @@ Update a given VPNService.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </chapter>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="novaclient_commands"> xml:id="novaclient_commands">
@ -6812,4 +6812,4 @@ Fetch the x509 root cert.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </chapter>

View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="swiftclient_commands"> xml:id="swiftclient_commands">
@ -779,4 +779,4 @@ If the container is not found, it will be created automatically.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </chapter>

View File

@ -49,7 +49,7 @@
</section> </section>
<section xml:id="associate-glance-cli-commands"> <section xml:id="associate-glance-cli-commands">
<title>Image CLI Commands</title> <title>Image CLI Commands</title>
<xi:include href="../common/section_cli_glance_commands.xml" <xi:include href="../common/ch_cli_glance_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'glanceclient_commands']/*[not(self::db:title)])"> xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'glanceclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback> <xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include> </xi:include>

View File

@ -35,7 +35,7 @@
<title>Administration Tasks</title> <title>Administration Tasks</title>
<section xml:id="associate-block-storage-commands"> <section xml:id="associate-block-storage-commands">
<title>Block Storage CLI Commands</title> <title>Block Storage CLI Commands</title>
<xi:include href="../common/section_cli_cinder_commands.xml" <xi:include href="../common/ch_cli_cinder_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'cinderclient_commands']/*[not(self::db:title)])"> xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'cinderclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback> <xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include> </xi:include>
@ -49,7 +49,7 @@
</section> </section>
<section xml:id="associate-nova-cli-commands"> <section xml:id="associate-nova-cli-commands">
<title>Compute CLI Commands</title> <title>Compute CLI Commands</title>
<xi:include href="../common/section_cli_nova_commands.xml" <xi:include href="../common/ch_cli_nova_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'novaclient_commands']/*[not(self::db:title)])"> xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'novaclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback> <xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include> </xi:include>

View File

@ -28,7 +28,7 @@
<title>Administration Tasks</title> <title>Administration Tasks</title>
<section xml:id="associate-network-cli-commands"> <section xml:id="associate-network-cli-commands">
<title>Network CLI Commands</title> <title>Network CLI Commands</title>
<xi:include href="../common/section_cli_neutron_commands.xml" <xi:include href="../common/ch_cli_neutron_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'neutronclient_commands']/*[not(self::db:title)])"> xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'neutronclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback> <xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include> </xi:include>

View File

@ -28,7 +28,7 @@
<title>Administration Tasks</title> <title>Administration Tasks</title>
<section xml:id="associate-object-store-cli-commands"> <section xml:id="associate-object-store-cli-commands">
<title>Object Storage CLI Commands</title> <title>Object Storage CLI Commands</title>
<xi:include href="../common/section_cli_swift_commands.xml" <xi:include href="../common/ch_cli_swift_commands.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'swiftclient_commands']/*[not(self::db:title)])"> xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'swiftclient_commands']/*[not(self::db:title)])">
<xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback> <xi:fallback><para><mediaobject><imageobject><imagedata fileref="figures/openstack-training-remote-content-not-available.png" format="PNG"/></imageobject></mediaobject>Remote content not available</para><para>image source</para><para><link xlink:href="https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing">https://docs.google.com/drawings/d/1J2LZSxmc06xKyxMgPjv5fC0blV7qK6956-AeTmFOZD4/edit?usp=sharing</link></para></xi:fallback>
</xi:include> </xi:include>