-
Notifications
You must be signed in to change notification settings - Fork 259
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds starting point for an OpenStack CLI guide.
Patchset reorganizes based on feedback. Patchset 4 and 5 addresses Diane's feedback, separating out version, help, and so on. Patchset 6 renames some files, adds some glance CLI commands in an outline, unfinished. Fixes bug 1019718 bug 1031578 bug 988902 Change-Id: I530b29eca200830d866b09431e522efdc3454f2c
- Loading branch information
1 parent
65b9fbe
commit d68bcba
Showing
23 changed files
with
2,177 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| <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-guide</artifactId> | ||
| <version>1.0.0-SNAPSHOT</version> | ||
| <packaging>jar</packaging> | ||
| <name>OpenStack CLI Guide</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.4.0</version> | ||
| <executions> | ||
| <!--<execution> | ||
| <id>goal1</id> | ||
| <goals> | ||
| <goal>generate-pdf</goal> | ||
| </goals> | ||
| <phase>generate-sources</phase> | ||
| <configuration> | ||
| <highlightSource>false</highlightSource> | ||
| <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 --> | ||
| <enableDisqus>1</enableDisqus> | ||
| <disqusShortname>os-cliguide</disqusShortname> | ||
| <enableGoogleAnalytics>1</enableGoogleAnalytics> | ||
| <googleAnalyticsId>UA-17511903-6</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--> | ||
| <webhelpIncludeSearchTab>false</webhelpIncludeSearchTab> | ||
| <chapterAutolabel>0</chapterAutolabel> | ||
| <chunkFirstSections>0</chunkFirstSections> | ||
| <sectionAutolabel>0</sectionAutolabel> | ||
| <sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel> | ||
| <preProcess> | ||
| <mkdir | ||
| dir="${project.build.directory}/docbkx/webhelp/bk-cli-guide/content"/> | ||
| <echo | ||
| file="${project.build.directory}/docbkx/webhelp/bk-cli-guide/content/deleteme.html"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <body> | ||
| <div id="content"> | ||
| <p>foo bar baz</p> | ||
| </div> | ||
| </body> | ||
| </html> | ||
| </echo> | ||
| </preProcess> | ||
| <postProcess> | ||
| <delete | ||
| file="${project.build.directory}/docbkx/webhelp/bk-cli-guide/content/deleteme.html"/> | ||
| </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/bk-cli-guide/content/</canonicalUrlBase>--> | ||
| <profileSecurity>reviewer</profileSecurity> | ||
| <branding>openstack</branding> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
|
|
||
| </project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?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"> | ||
| <title>OpenStack CLI Guide</title> | ||
| <?dbhtml stop-chunking?> | ||
| <para> Each OpenStack project has a Command-Line-Interface (CLI) | ||
| that interacts with the service's REST API. </para> | ||
|
|
||
| <xi:include href="cli_overview.xml" /> | ||
| <xi:include href="cli_credentials.xml" /> | ||
| <xi:include href="cli_version.xml" /> | ||
| <xi:include href="cli_help.xml" /> | ||
| <xi:include href="nova_cli_install.xml"/> | ||
| <xi:include href="nova_cli_commands.xml"/> | ||
| <xi:include href="nova_cli_howto.xml"/> | ||
| <xi:include href="glance_cli_install.xml"/> | ||
| <xi:include href="glance_cli_commands.xml"/> | ||
| <xi:include href="glance_cli_howto.xml"/> | ||
| <xi:include href="keystone_cli_install.xml"/> | ||
| <xi:include href="keystone_cli_commands.xml"/> | ||
| <xi:include href="swift_cli_install.xml"/> | ||
| <xi:include href="swift_cli_commands.xml"/> | ||
| <!--<xi:include href="quantum_cli_install.xml"/> | ||
| <xi:include href="quantum_cli_commands.xml"/>--> | ||
|
|
||
| </chapter> |
Oops, something went wrong.