openstack/openstack-manuals
Code Issues Proposed changes
181 Commits 4 Branches 2 Tags
1c94ed77a6
Go to file
Ewan Mellor 1c94ed77a6 Bug #883218: No documentation for installing OpenStack Compute with XenServer as hypervisor 
Bug #938408: Possible typo in a relevant technical term

Added <?dbhtml stop-chunking?> processing instruction so the introduction appears as a single page.
Add an introduction to Xen, XCP, and XenServer, with explanation of the
variety of technical terms.  This is included as part of the Installing
OpenStack Compute and Image Service chapter in the installation manual, and
the Hypervisors chapter of the compute admin manual.

Change-Id: I381e9b8ec19638ba90a8436fdcb6b5059f3ff963
2012-03-19 09:44:14 -05:00
doc/src/docbkx
Bug #883218: No documentation for installing OpenStack Compute with XenServer as hypervisor
2012-03-19 09:44:14 -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.

Description
OpenStack Manuals
Readme 476 MiB
Languages
HTML 78.4%
CSS 12.2%
Python 4.8%
JavaScript 3.3%
Shell 1.3%