Mike Asthalter 99f4f1bd9a Begin 3 chapters for Orch API Ref Manual
- The original heat wadl (heat-api-1.0.wadl) and the samples have now
been deleted from this repo. The wadl has been renamed and migrated
to the following location along with the samples:
https://github.com/openstack/api-site/blob/master/api-ref/src/wadls/
orchestration-api/src/v1/orchestration-api.wadl

- Inserted api-ref/src/wadls/heat-api/src/README.rst file in repo
that specifies the new wadl location.

- Updated pom file to latest version of clouddocs-maven-plugin.

- Currently clouddocs-maven-plugin 1.11.0 has a bug which creates
new sections for the request and response examples for each API
call. This will be fixed in an upcoming release of the plugin.

- Several remarks are inserted in the manual text and marked with
security="writeronly" so they do not appear in the output. You
are welcome to provide any answers and feedback you may have for
these remarks.

- Fix title for commit to resolve H803 build exception.

- Fix extra spaces in file /wadls/heat-api/src/README.rst, and
wrap lines in commit message at less than 70 characters.

Change-Id: I478b394268f64b41317ab77fff6d6366ddd7efa1
2013-10-09 10:04:33 -05:00

80 lines
4.1 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/xsd/maven-4.0.0.xsd">
<!-- POM Build file for the Orchestration API Developer Guide -->
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<modelVersion>4.0.0</modelVersion>
<groupId>org.openstack.identity</groupId>
<artifactId>docs</artifactId>
<version>1.0</version>
<packaging>jar</packaging>
<name>OpenStack API Page Project</name>
<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>
<snapshots>
<updatePolicy>always</updatePolicy>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<doctools.version>1.11.0</doctools.version>
</properties>
<build>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>${doctools.version}</version>
<executions>
<execution>
<id>g1</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<highlightSource>false</highlightSource>
<enableGoogleAnalytics>1</enableGoogleAnalytics>
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
</configuration>
</execution>
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src/docbkx</sourceDirectory>
<includes>
api-ref.xml
</includes>
<profileSecurity>reviewer</profileSecurity>
<branding>openstack</branding>
<trimWadlUriCount>2</trimWadlUriCount>
<showXslMessages>true</showXslMessages>
</configuration>
</plugin>
</plugins>
</build>
</project>