Remove heat-cli-guide

The heat command line clients are documented now better in the
OpenStack End User Guide:

http://docs.openstack.org/user-guide/content/heat-stack-create.html
http://docs.openstack.org/user-guide/content/heat_client_commands.html

The content here is thus not needed anymore, as the README.rst says:
"This documentation should eventually end up in the OpenStack
documentation repositories `api-site` and `openstack-manuals`."

Change-Id: I297252d7f8eee383ce6252a5db44111630fbe29b
This commit is contained in:
Andreas Jaeger 2014-01-11 11:55:40 +01:00
parent 21f97a0262
commit 929fa9cfdd
6 changed files with 0 additions and 270 deletions

View File

@ -29,7 +29,3 @@ Build the Heat admin guide:
cd heat-admin cd heat-admin
mvn clean generate-sources mvn clean generate-sources
Build the Heat CLI guide:
cd heat-cli-guide
mvn clean generate-sources

View File

@ -1,132 +0,0 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.openstack.docs</groupId>
<artifactId>openstack-cli-guide</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>OpenStack CLI Guides</name>
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<profiles>
<profile>
<id>Rackspace Research Repositories</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<build>
<resources>
<resource>
<directory>target/docbkx/pdf</directory>
<excludes>
<exclude>**/*.fo</exclude>
</excludes>
</resource>
</resources>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.12.2</version>
<executions>
<execution>
<id>goal1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<!--<pdfUrl>cli-guide.pdf</pdfUrl>-->
<highlightSource>false</highlightSource>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<sectionAutolabel>0</sectionAutolabel>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>
</configuration>
</execution>
<execution>
<id>goal2</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<!-- These parameters only apply to webhelp -->
<pdfUrl>cli-guide.pdf</pdfUrl>
<enableDisqus>1</enableDisqus>
<disqusShortname>os-cliguide</disqusShortname>
<enableGoogleAnalytics>1</enableGoogleAnalytics>
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
<generateToc>
appendix toc,title
article/appendix nop
article toc,title
book title,figure,table,example,equation
chapter toc,title
part toc,title
preface toc,title
qandadiv toc
qandaset toc
reference toc,title
set toc,title
</generateToc>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<sectionAutolabel>0</sectionAutolabel>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>
<postProcess>
<!-- Copies webhelp (HTML output) to desired URL location on docs.openstack.org -->
<copy
todir="${basedir}/target/docbkx/webhelp/cli-guide/">
<fileset
dir="${basedir}/target/docbkx/webhelp/bk-cli-guide/">
<include name="**/*" />
</fileset>
</copy>
<!--Moves PDF to the needed placement -->
<move failonerror="false"
file="${basedir}/target/docbkx/pdf/bk-cli-guide.pdf"
tofile="${basedir}/target/docbkx/webhelp/cli-guide/content/cli-guide.pdf"/>
<!--Deletes leftover uneeded directories -->
<delete dir="${basedir}/target/docbkx/webhelp/bk-cli-guide"/>
</postProcess>
</configuration>
</execution>
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src</sourceDirectory>
<includes>
bk-cli-guide.xml
</includes>
<!--<canonicalUrlBase>http://docs.openstack.org/cli/content/</canonicalUrlBase>-->
<profileSecurity>reviewer</profileSecurity>
<branding>openstack</branding>
</configuration>
</plugin>
</plugins>
</build>
</project>

View File

@ -1,15 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:html="http://www.w3.org/1999/xhtml" version="5.0"
xml:id="openstack-cli-guide-trunk">
<title>OpenStack CLI Guide</title>
<para>Each OpenStack project has a Command-Line-Interface (CLI)
that interacts with the service's REST API. </para>
<xi:include href="heat_cli_install.xml"/>
<xi:include href="heat_cli_commands.xml"/>
<xi:include href="heat_cli_howto.xml"/>
</chapter>

View File

@ -1,22 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<section 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="heat_client_commands">
<title>Command List for heat CLI</title>
<literallayout class="monospaced">
event-list List events for a stack
event-show Describe the event
resource-list Show list of resources belonging to a stack
resource-metadata List resource metadata
resource-show Describe the resource
stack-create Create the stack
stack-delete Delete the stack
stack-list List the user's stacks
stack-show Describe the stack
stack-update Update the stack
template-show Get the template for the specified stack
template-validate Validate a template with parameters
help Display help about this program or one of its subcommands.
</literallayout>
</section>

View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:html="http://www.w3.org/1999/xhtml"
version="5.0"
xml:id="neutron-cli-reference">
<?dbhtml stop-chunking?>
<title>OpenStack Heat CLI Guide</title>
<para>This section describes heat commands</para>
</section>

View File

@ -1,84 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<section 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="install_openstack_heat_cli">
<title>Install OpenStack heat CLI</title>
<para>This example walks through installing the heat client. After
you install a client, you must configure environment variables
for authentication. </para>
<procedure>
<title>To install the heat client:</title>
<step>
<title>Install Python</title>
<para>Install Python 2.6 or later. Currently, the heat
client does not support Python 3. </para>
</step>
<step>
<title>Install the heat client package</title>
<para>Choose one of the following methods to install the
heat client package. <itemizedlist>
<listitem>
<para><emphasis role="bold">Recommended
method:</emphasis>
<command>pip</command></para>
<para>Install <command>pip</command> through
the package manager for your
system:<informaltable rules="all">
<col width="20%"/>
<col width="80%"/>
<thead>
<tr>
<th>System</th>
<th>Command</th>
</tr>
</thead>
<tbody>
<tr>
<td>Mac OS X</td>
<td>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> sudo easy_install pip</programlisting>
</td>
</tr>
<tr>
<td>Ubuntu</td>
<td>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> aptitude install python-pip </programlisting>
</td>
</tr>
<tr>
<td>RHEL, CentOS, or Fedora:</td>
<td>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> yum install python-pip</programlisting>
</td>
</tr>
</tbody>
</informaltable></para>
<para>Run the following command to install the heat client package:
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> sudo pip install python-heatclient</programlisting></para>
</listitem>
<listitem>
<para><emphasis role="bold"
>easy_install</emphasis></para>
<para>Run the following command to install the
heat client package: </para>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> sudo easy_install python-heatclient</programlisting>
</listitem>
</itemizedlist></para>
</step>
<step>
<title>Get help for heat client commands</title>
<para>To get help for heat client commands, run the
following command:</para>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> heat -h </programlisting>
<para>Depending on your user credentials, you may not have
permissions to use every command that is listed. The
heat client was written for use with recent
development versions of OpenStack.</para>
<para>To get help for a specific command, type the command
name after the <parameter>help</parameter> parameter,
as follows:</para>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> heat help &lt;command_name&gt; </programlisting>
</step>
</procedure></section>