openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
143 Commits 4 Branches 2 Tags 472 MiB
HTML 77.1%
CSS 13%
Python 5%
JavaScript 3.5%
Shell 1.4%
Go to file
Jesse Andrews f3e064c824 Use 3 columns instead of 2 + wall of text 
* update titles to be unique per page
 * three sections: Software Manuals, API Developer Manuals, Developer Documentation
 * moved the "related resources" to either API or Developer sections
 * removed domain (docs.openstack.org) from paths (like CSS/images/links) - makes it easier to developer
 * Update titles and headings of columns

Change-Id: I1be0c0f95cec637303778b80d4f61c8cba933ec5
 		2012-03-06 00:23:59 +00:00
doc Merge "Fix bug #928977 : Wrong glance endpoint services" 2012-03-06 00:12:54 +00:00
tools Add rfc.sh to help with gerrit workflow. 2011-09-15 15:03:40 -07:00
www Use 3 columns instead of 2 + wall of text 2012-03-06 00:23:59 +00:00
.gitignore standardize capitalization: ReST -> REST 2012-02-29 23:18:48 -08:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
README.rst Add explanation on how to install maven on Ubuntu :) 2012-03-05 17:58:31 +00:00

README.rst

This repository contains the cloud administrator documentation for the OpenStack project. It includes documentation for OpenStack Compute, OpenStack Identity Service, OpenStack Image Service, and OpenStack Object Storage as well as the Dashboard.

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

In addtion to the guides, this repostiory contains:
  • api.openstack.org site: doc/src/docbkx/openstack-api-site
  • index & resources for docs.openstack.org: www

Prereqs

Apache Maven must be installed to build the documentation.

To install Maven for Ubuntu:

apt-get install maven2

Building

To build the Compute Admin Manual, Object Storage Admin Manual, and Image Service Manual:

cd openstack-manuals/doc
mvn clean generate-sources

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, or blogs. 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.