openstack/openstack-manuals
Code Issues Proposed changes

Remove Command Reference appendix

Browse Source 
Remove the appendix from End User and Admin User guides.
Add new manual to the list of all manuals in the support appendix.

Update references to point to new book.

Change-Id: I0cc12c45b5487a18c8de285f4ef939dcab4c4831
This commit is contained in:
Andreas Jaeger 2014-01-31 20:42:10 +01:00
parent 4ccdd1fbdc
commit ffe693f368
5 changed files with 42 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/common/app_command_reference.xml
View File

@ -1,41 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE appendix [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!-- 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>'>
]>
<appendix 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="app_command_reference">
<title>Command reference</title>
<xi:include
href="section_cli_keystone_commands.xml"/>
<?hard page-break?>
<xi:include
href="section_cli_glance_commands.xml"/>
<?hard page-break?>
<xi:include
href="section_cli_neutron_commands.xml"/>
<?hard page-break?>
<xi:include
href="section_cli_nova_commands.xml"/>
<?hard page-break?>
<xi:include
href="section_cli_cinder_commands.xml"/>
<?hard page-break?>
<xi:include
href="section_cli_swift_commands.xml"/>
<?hard page-break?>
<xi:include
href="section_cli_heat_commands.xml"/>
<?hard page-break?>
<xi:include
href="section_cli_ceilometer_commands.xml"/>
</appendix>

8
doc/common/app_support.xml
View File

@ -125,6 +125,14 @@
><citetitle>Admin User Guide</citetitle></link>
</para>
</listitem>
<listitem>
<para>
<link
xlink:href="http://docs.openstack.org/cli-reference/content/"
><citetitle>Command Line Interface
Reference</citetitle></link>
</para>
</listitem>
</itemizedlist>
<para>The following documentation provides reference and
guidance information for the OpenStack APIs:</para>

16
doc/user-guide-admin/bk-admin-user-guide.xml
View File

@ -44,6 +44,21 @@
commands.</para>
</abstract>
<revhistory>
<revision>
<date>2014-01-31</date>
<revdescription>
<itemizedlist>
<listitem>
<para>Remove the command reference
appendix. This information is now in <link
xlink:href="http://docs.openstack.org/cli-reference/content/"><citetitle>OpenStack
Command Line Interface
Reference</citetitle></link>.
</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
<revision>
<date>2013-10-17</date>
<revdescription>
@ -70,6 +85,5 @@
<xi:include href="../common/ch_using_openstack_overview.xml"/>
<xi:include href="ch_dashboard.xml"/>
<xi:include href="ch_cli.xml"/>
<xi:include href="../common/app_command_reference.xml"/>
<xi:include href="../common/app_support.xml"/>
</book>

5
doc/user-guide-admin/section_cli_admin_manage_stacks.xml
View File

@ -20,7 +20,10 @@
<link xlink:href="http://docs.openstack.org/user-guide/content/dashboard_stacks.html">End User Guide</link>.</para>
</listitem>
<listitem>
<para><systemitem>heat</systemitem> CLI commands, see <xref linkend="heatclient_commands"/></para>
<para><systemitem>heat</systemitem> CLI commands, see the <link
xlink:href="http://docs.openstack.org/cli-reference/content/"><citetitle>
OpenStack Command Line Interface Reference</citetitle></link>
</para>
</listitem>
</itemizedlist>
</para>

16
doc/user-guide/bk-user-guide.xml
View File

@ -44,6 +44,21 @@
commands.</para>
</abstract>
<revhistory>
<revision>
<date>2014-01-31</date>
<revdescription>
<itemizedlist>
<listitem>
<para>Remove the command reference
appendix. This information is now in <link
xlink:href="http://docs.openstack.org/cli-reference/content/"><citetitle>OpenStack
Command Line Interface
Reference</citetitle></link>.
</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
<revision>
<date>2013-12-30</date>
<revdescription>
@ -92,6 +107,5 @@
<xi:include href="ch_dashboard.xml"/>
<xi:include href="ch_cli.xml"/>
<xi:include href="ch_sdk.xml"/>
<xi:include href="../common/app_command_reference.xml"/>
<xi:include href="../common/app_support.xml"/>
</book>