OpenStack Manuals
Go to file
Scott Radvan d782c62427 General readability improvements
* Expand 'Univ' to 'University' for correctness.
* Remove scattered instances of double-spacing between sentences so that guide is consistent.
* Use '—' instead of '-' to improve appearance of list items.
* Adjust preposition placements to improve grammar.
* Add an xref instead of advising reader to "read below" so that we do a better job of guiding the reader through the document.
* Remove stray, empty <emphasis> items to clean up code.
* Remove unnecessary hyphens to improve grammar correctness.
* Other minor grammar improvements.

Change-Id: I0dffd2e05cf89e4a9421512cb4e24a2ee242e21d
2013-09-12 20:10:04 +10:00
.tx Add slicing tool to the master branch 2013-03-14 10:53:54 +08:00
doc General readability improvements 2013-09-12 20:10:04 +10:00
tools Do not build all books if only www/ is changed 2013-09-10 10:04:11 +02:00
www Fix html markup to show all guides 2013-09-10 22:23:40 +02:00
.gitignore Ignore emacs backup files 2013-09-10 22:54:26 +02:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Check if Maven is building the docs 2012-10-26 00:49:29 +05:30

Openstack Manuals

This repository contains the cloud administrator documentation for the OpenStack project. It includes documentation for:

  • OpenStack Compute
  • OpenStack Identity Service
  • OpenStack Image Service
  • OpenStack Object Storage
  • OpenStack Dashboard
  • OpenStack Network Connectivity
  • OpenStack Volumes

For more details, see the OpenStack Documentation HowTo wiki page.

In addition to the guides, this repository contains:

  • api.openstack.org: doc/src/docbkx/openstack-api-site
  • docs.openstack.org: www

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:

apt-get install maven

On Fedora 15 and later:

yum install maven3

Building

The different manuals are in subdirectories of the openstack-manuals/doc/src/docbkx directory.

For example, the root directory of the OpenStack Compute Administration Guide is openstack-manuals/doc/src/docbkx/openstack-compute-admin.

To build a specific guide, look for a pom.xml file within a subdirectory, then run the mvn command in that directory. For example:

cd openstack-manuals/doc/src/docbkx/openstack-compute-admin
mvn clean generate-sources

The generated PDF documentation file is:

openstack-manuals/doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/trunk/openstack-compute/admin/os-compute-adminguide-trunk.pdf

The root of the generated HTML documentation is:

openstack-manuals/doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/os-compute-adminguide/content/index.html

Contributing

Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, blogs, or on IRC at #openstack on irc.freenode.net.

We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Installing

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.