OpenStack Manuals

Go to file

Diane Fleming 64b6c9261e Folder rename, file rename, flattening of directories Current folder name New folder name Book title ---------------------------------------------------------- basic-install DELETE cli-guide DELETE common common NEW admin-guide-cloud Cloud Administrators Guide docbkx-example DELETE openstack-block-storage-admin DELETE openstack-compute-admin DELETE openstack-config config-reference OpenStack Configuration Reference openstack-ha high-availability-guide OpenStack High Availabilty Guide openstack-image image-guide OpenStack Virtual Machine Image Guide openstack-install install-guide OpenStack Installation Guide openstack-network-connectivity-admin admin-guide-network OpenStack Networking Administration Guide openstack-object-storage-admin DELETE openstack-security security-guide OpenStack Security Guide openstack-training training-guide OpenStack Training Guide openstack-user user-guide OpenStack End User Guide openstack-user-admin user-guide-admin OpenStack Admin User Guide glossary NEW OpenStack Glossary bug: #1220407 Change-Id: Id5ffc774b966ba7b9a591743a877aa10ab3094c7 author: diane fleming		2013-09-08 15:15:50 -07:00
.tx	Add slicing tool to the master branch	2013-03-14 10:53:54 +08:00
doc	Folder rename, file rename, flattening of directories	2013-09-08 15:15:50 -07:00
tools	Fix output of tools/validate.py --force	2013-09-06 13:43:11 -05:00
www	Remove Object Storage Guide from trunk index page	2013-09-06 11:03:29 +02:00
.gitignore	Update Nexenta driver doc	2013-09-05 01:28:56 +04: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

README.rst

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.