From 927b792371f6cb436047cc9c7d68a134f11067ae Mon Sep 17 00:00:00 2001
From: Diane Fleming <diane.fleming@rackspace.com>
Date: Thu, 16 Jan 2014 10:46:26 -0600
Subject: [PATCH] Add stub files for new API Guide

Closes-Bug: #1269854

Change-Id: I01cc24ea65a69b5e1df532570a14de6f123e149f
author: Diane Fleming <diane.fleming@rackspace.com>
co-author: Miranda Zhang <miranda.zhang.q@gmail.com>
---
 api-guide/bk-api-guide.xml           | 64 +++++++++++++++++++++++
 api-guide/ch_api_concepts.xml        | 13 +++++
 api-guide/ch_api_getting_started.xml |  9 ++++
 api-guide/ch_api_limits.xml          | 13 +++++
 api-guide/ch_api_usage.xml           | 14 +++++
 api-guide/pom.xml                    | 77 ++++++++++++++++++++++++++++
 pom.xml                              |  1 +
 7 files changed, 191 insertions(+)
 create mode 100644 api-guide/bk-api-guide.xml
 create mode 100644 api-guide/ch_api_concepts.xml
 create mode 100644 api-guide/ch_api_getting_started.xml
 create mode 100644 api-guide/ch_api_limits.xml
 create mode 100644 api-guide/ch_api_usage.xml
 create mode 100644 api-guide/pom.xml

diff --git a/api-guide/bk-api-guide.xml b/api-guide/bk-api-guide.xml
new file mode 100644
index 000000000..cef47bbd4
--- /dev/null
+++ b/api-guide/bk-api-guide.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book [
+]>
+<book 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:m="http://www.w3.org/1998/Math/MathML"
+    xmlns:html="http://www.w3.org/1999/xhtml"
+    xmlns:db="http://docbook.org/ns/docbook" version="5.0"
+    xml:id="os-api-guide">
+    <title>OpenStack API Guide</title>
+    <titleabbrev>API Guide</titleabbrev>
+    <info>
+        <author>
+            <personname>
+                <firstname/>
+                <surname/>
+            </personname>
+            <affiliation>
+                <orgname>OpenStack Foundation</orgname>
+            </affiliation>
+        </author>
+        <copyright>
+            <year>2014</year>
+            <holder>OpenStack Foundation</holder>
+        </copyright>
+        <releaseinfo>local</releaseinfo>
+        <productname>OpenStack</productname>
+        <pubdate/>
+        <legalnotice role="cc-by">
+            <annotation>
+                <remark>Copyright details are filled in by the
+                    template.</remark>
+            </annotation>
+        </legalnotice>
+        <abstract>
+            <para>OpenStack is an open source cloud computing platform
+                for public and private clouds. A series of
+                interrelated projects deliver a cloud infrastructure
+                solution. This guide is for developers who want to
+                extend the OpenStack APIs or write applications that
+                run on an OpenStack cloud. This guide introduces
+                developers to OpenStack API concepts, common tasks,
+                and ways of interacting with the APIs.</para>
+        </abstract>
+        <revhistory>
+            <revision>
+                <date>2014-01-30</date>
+                <revdescription>
+                    <itemizedlist>
+                        <listitem>
+                            <para>First edition of this book.</para>
+                        </listitem>
+                    </itemizedlist>
+                </revdescription>
+            </revision>
+        </revhistory>
+    </info>
+    <xi:include href="ch_api_getting_started.xml"/>
+    <xi:include href="ch_api_limits.xml"/>
+    <xi:include href="ch_api_concepts.xml"/>
+    <xi:include href="ch_api_usage.xml"/>
+</book>
diff --git a/api-guide/ch_api_concepts.xml b/api-guide/ch_api_concepts.xml
new file mode 100644
index 000000000..4a4e96c2c
--- /dev/null
+++ b/api-guide/ch_api_concepts.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter [
+]>
+<chapter xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:raxm="http://docs.rackspace.com/api/metadata" version="5.0"
+    xml:id="ch_api_concepts">
+    <info>
+        <title>API concepts</title>
+    </info>
+    <para></para>
+</chapter>
diff --git a/api-guide/ch_api_getting_started.xml b/api-guide/ch_api_getting_started.xml
new file mode 100644
index 000000000..3979e9e8e
--- /dev/null
+++ b/api-guide/ch_api_getting_started.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<chapter xmlns="http://docbook.org/ns/docbook"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ch_api_overview">
+  <info>
+    <title>API overview</title>
+  </info>
+ <para></para>
+</chapter>
diff --git a/api-guide/ch_api_limits.xml b/api-guide/ch_api_limits.xml
new file mode 100644
index 000000000..5813d04d3
--- /dev/null
+++ b/api-guide/ch_api_limits.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter [
+]>
+<chapter xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:raxm="http://docs.rackspace.com/api/metadata" version="5.0"
+    xml:id="ch_api_limits">
+    <info>
+        <title>API limits</title>
+    </info>
+    <para></para>
+</chapter>
diff --git a/api-guide/ch_api_usage.xml b/api-guide/ch_api_usage.xml
new file mode 100644
index 000000000..3fb506fda
--- /dev/null
+++ b/api-guide/ch_api_usage.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter [
+]>
+<chapter xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:raxm="http://docs.rackspace.com/api/metadata" version="5.0"
+    xml:id="ch_api_usage">
+    <info>
+        <title>Use the APIs</title>
+    </info>
+    <para>Provide tutorials, examples, interspersed with specific API
+        concepts?</para>
+</chapter>
diff --git a/api-guide/pom.xml b/api-guide/pom.xml
new file mode 100644
index 000000000..dbc1434eb
--- /dev/null
+++ b/api-guide/pom.xml
@@ -0,0 +1,77 @@
+<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">
+  <parent>
+    <groupId>org.openstack.docs</groupId>
+    <artifactId>parent-pom</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <relativePath>../pom.xml</relativePath>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+  <artifactId>openstack-api-guide</artifactId>
+  <packaging>jar</packaging>
+  <name>OpenStack API Guide</name>
+  <properties>
+    <!-- This is set by Jenkins according to the branch. -->
+    <release.path.name>local</release.path.name>
+    <comments.enabled>0</comments.enabled>
+  </properties>
+  <!-- ################################################ -->
+  <!-- USE "mvn clean generate-sources" to run this POM -->
+  <!-- ################################################ -->
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>com.rackspace.cloud.api</groupId>
+        <artifactId>clouddocs-maven-plugin</artifactId>
+        <!-- version is set in ../pom.xml file -->
+        <executions>
+          <!-- Configuration for OpenStack End User Guide -->
+          <execution>
+            <id>os-api-guide</id>
+            <goals>
+              <goal>generate-webhelp</goal>
+            </goals>
+            <phase>generate-sources</phase>
+            <configuration>
+              <includes> bk-api-guide.xml</includes>
+              <generateToc>
+                appendix  toc,title
+                article/appendix  nop
+                article   toc,title
+                book      toc,title,figure,table,example,equation
+                chapter   toc,title
+                section   toc
+                part      toc,title
+                qandadiv  toc
+                qandaset  toc
+                reference toc,title
+                set       toc,title
+              </generateToc>
+              <targetDirectory>target/docbkx/webhelp</targetDirectory>
+              <webhelpDirname>api-guide</webhelpDirname>
+              <pdfFilenameBase>api-guide</pdfFilenameBase>
+            </configuration>
+          </execution>
+        </executions>
+        <configuration>
+          <chapterAutolabel>1</chapterAutolabel>
+          <sectionAutolabel>0</sectionAutolabel>
+          <tocSectionDepth>1</tocSectionDepth>
+          <formalProcedures>0</formalProcedures>
+          <highlightSource>false</highlightSource>
+          <xincludeSupported>true</xincludeSupported>
+          <showXslMessages>true</showXslMessages>
+          <sourceDirectory>.</sourceDirectory>
+          <security>external</security>
+          <branding>openstack</branding>
+          <enableDisqus>${comments.enabled}</enableDisqus>
+          <disqusShortname>os-api-guide</disqusShortname>
+          <enableGoogleAnalytics>1</enableGoogleAnalytics>
+          <googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
+          <suppressFooterNavigation>0</suppressFooterNavigation>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>
diff --git a/pom.xml b/pom.xml
index 6083f6516..664e0ea5c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -10,6 +10,7 @@
 
   <modules>
     <module>api-quick-start</module>
+    <module>api-guide</module>
     <module>api-ref</module>
    <!-- <module>api-ref-books</module>-->
   </modules>