openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
1,575 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
6712435ff8
Go to file
annegentle 6712435ff8 Removes nova-volumes/nova-volume surgically, replace with Block 
Storage.

Not sure about lgm vs tgts, etc, in the configuration sections. It
seems ok to leave both as examples but needs review.

Fix bug 1007528
Fix bug 1074200
Fix bug 1078353
Fix bug 1153869

Patchset addresses reviewer's comments.

Patchset fixes new bug, init should be ini and troubleshooting.

Patchset addresses question about networking.

Change-Id: Ib6f325ba11c5cff01364ef787c52cdc57ee8f70f
2013-03-19 04:04:08 +00:00
.tx Add slicing tool to the master branch 2013-03-14 10:53:54 +08:00
doc/src/docbkx Removes nova-volumes/nova-volume surgically, replace with Block 2013-03-19 04:04:08 +00:00
tools Add slicing tool to the master branch 2013-03-14 10:53:54 +08:00
www Removes link to booktype as that book is migrated to our toolchain. 2013-03-12 11:08:25 -05:00
.gitignore Ignore vim swap files 2012-10-02 23:21:27 +00: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.