diff --git a/doc/docbkx/README.rst b/doc/docbkx/README.rst new file mode 100644 index 000000000..ce7529807 --- /dev/null +++ b/doc/docbkx/README.rst @@ -0,0 +1,31 @@ +================================ +Building the user and admin docs +================================ + +This documentation should eventually end up in the OpenStack documentation +repositories `api-site` and `openstack-manuals`. + +Dependencies +============ + +on Ubuntu: + + sudo apt-get install maven + +on Fedora Core: + + sudo yum install maven + +Use `mvn` +========= + +Build the REST API reference manual: + + cd api-ref + mvn clean generate-sources + +Build the Heat admin guide: + + cd senlin-admin + mvn clean generate-sources + diff --git a/doc/docbkx/senlin-admin/app_core.xml b/doc/docbkx/senlin-admin/app_core.xml new file mode 100644 index 000000000..e1901b176 --- /dev/null +++ b/doc/docbkx/senlin-admin/app_core.xml @@ -0,0 +1,16 @@ + + + + + + + +]> + + Core Configuration File Options + TODO + diff --git a/doc/docbkx/senlin-admin/bk-senlin-admin-guide.xml b/doc/docbkx/senlin-admin/bk-senlin-admin-guide.xml new file mode 100644 index 000000000..801af3d44 --- /dev/null +++ b/doc/docbkx/senlin-admin/bk-senlin-admin-guide.xml @@ -0,0 +1,69 @@ + + + + + + + +]> + + + Senlin Administration Guide + + + + + + + + + 2015 + OpenStack + + Kilo (2015.1) + Senlin + 2014-12-10 + + + Copyright details are filled in by the template. + + + + This document is intended for administrators interested in running the Senlin Service. + + + + + + 2012-12-14 + + + + First edition of this document. + + + + + + + + + + + + + + + + + diff --git a/doc/docbkx/senlin-admin/ch_install.xml b/doc/docbkx/senlin-admin/ch_install.xml new file mode 100644 index 000000000..dce01810a --- /dev/null +++ b/doc/docbkx/senlin-admin/ch_install.xml @@ -0,0 +1,19 @@ + + + + + + + +]> + + Senlin Installation + This chapter describes how to install the Senlin Service + and get it up and running. + diff --git a/doc/docbkx/senlin-admin/ch_limitations.xml b/doc/docbkx/senlin-admin/ch_limitations.xml new file mode 100644 index 000000000..b057431f4 --- /dev/null +++ b/doc/docbkx/senlin-admin/ch_limitations.xml @@ -0,0 +1,43 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + +'> + + + + + + + + +'> +]> + + Limitations + TODO + diff --git a/doc/docbkx/senlin-admin/ch_overview.xml b/doc/docbkx/senlin-admin/ch_overview.xml new file mode 100644 index 000000000..920a5f6c9 --- /dev/null +++ b/doc/docbkx/senlin-admin/ch_overview.xml @@ -0,0 +1,57 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + +'> + + + + + + + + +'> + + + + + + +powered by OpenStack'> +powered by OpenStack'> +]> + + Overview + This chapter describes the high-level concepts and + components of a Senlin deployment. + + diff --git a/doc/docbkx/senlin-admin/ch_preface.xml b/doc/docbkx/senlin-admin/ch_preface.xml new file mode 100644 index 000000000..2da181299 --- /dev/null +++ b/doc/docbkx/senlin-admin/ch_preface.xml @@ -0,0 +1,68 @@ + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + +'> + + + + + + + + +'> + + + + + + +powered by OpenStack'> +powered by OpenStack'> +]> + + Preface +
+ Intended Audience + TODO +
+
+ Document Change History + The most recent changes are described in the table + below: + +
+
+ Resources + TODO +
+ +
diff --git a/doc/docbkx/senlin-admin/ch_using.xml b/doc/docbkx/senlin-admin/ch_using.xml new file mode 100644 index 000000000..3c54a3834 --- /dev/null +++ b/doc/docbkx/senlin-admin/ch_using.xml @@ -0,0 +1,43 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + +'> + + + + + + + + +'> +]> + + Using Senlin + TODO + diff --git a/doc/docbkx/senlin-admin/pom.xml b/doc/docbkx/senlin-admin/pom.xml new file mode 100644 index 000000000..eb5aa3695 --- /dev/null +++ b/doc/docbkx/senlin-admin/pom.xml @@ -0,0 +1,151 @@ + + + + 4.0.0 + + org.openstack.docs + openstack-guide + 1.0.0-SNAPSHOT + jar + OpenStack Guides + + + + local + 1 + + + + + + + + Rackspace Research Repositories + + true + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + + + + + target/docbkx/pdf + + **/*.fo + + + + + + + com.rackspace.cloud.api + clouddocs-maven-plugin + 1.12.2 + + + goal1 + + generate-pdf + + generate-sources + + false + + 0 + 0 + + + + goal2 + + generate-webhelp + + generate-sources + + + ${comments.enabled} + 1 + os-senlin-guides + 1 + UA-17511903-1 + + 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 + + + 0 + 0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + . + + bk-senln-admin-guide.xml + + http://docs.openstack.org/${release.path.name}/senlin-admin/content/ + reviewer + openstack + + + + + +