c4777794e7
Here are some skeletons for the documentation which will need to be written.
doc/source
A Sphinx based document which will be aimed at heat developers.
This also contains .rst files which generate the man files
doc/docbkx/api-ref
Docbook and WADL for the REST API, with the intent of moving this
to api-site to publish to api.openstack.org
doc/docbkx/heat-admin
Docbook manual targeted at Heat admins, with the intent of moving this
to openstack-manuals to publish to docs.openstack.org
doc/docbkx/heat-cli
Docbook manual targeted at users of the Heat CLI, with the intent of
moving this to openstack-manuals to publish to docs.openstack.org
Dude, wheres my man pages?
docs/man
is deleted, now generated into doc/build/man
Packaging will need to be updated to generate the man pages
Change-Id: Idf2f37086b6f97df18ed57172de2f9e3d4c7706a
133 lines
5.0 KiB
XML
133 lines
5.0 KiB
XML
<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.5.1</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>
|