Go to file

annegentle 51e8b40aef Drafting updates to install/deploy

Fixed pom file to create a -trunk pdf.
Updated Dashboard image.
Added keystone.conf file after testing with a VM
Added more to glance validation steps
Still needs testing but might be close enough?
Also want to get Xen in there but we can publish before that.
Updated Keystone config based on reviews and Mailing List input.
Removed "identity management" chapter as it was overkill for this context.
Changed the ADMIN fake token to 012345SECRET99TOKEN012345.
Update to include Glance configuration files.
Updated to use an essex-style nova.conf file.
Please review with "draft" in mind and give feedback.

Change-Id: Ic7e50eddf7130bbbbce28f2646e2eb1d85583294

2012-03-19 11:13:38 -05:00

doc/src/docbkx

Drafting updates to install/deploy

2012-03-19 11:13:38 -05:00

tools

Add rfc.sh to help with gerrit workflow.

2011-09-15 15:03:40 -07:00

www

Work on consolidating to Compute admin guide only

2012-03-15 16:01:37 -05: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

LICENSE

bug 944097 adding apache license to openstack-manuals repo

2012-03-09 08:37:46 -06:00

README.rst

Update readme with maven3

2012-03-09 22:56:23 -06:00

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

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

In addtion 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 for Ubuntu:

apt-get install maven3

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

Languages

HTML 78.4%

CSS 12.2%

Python 4.8%

JavaScript 3.3%

Shell 1.3%