openstack/openstack-manuals
Code Issues Proposed changes
2,056 Commits 4 Branches 17 Tags
02fd76f83ad15865a78b23942e43b6034bce6b15
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Tom Fifield 02fd76f83a Fix computefilter/imagefilter confusion 
Looks like some copy/paste introduced errors in the scheduler guide

fixed as per bug report

patchset 2 fixes whitespace problems

fixes bug 1110428

Change-Id: Id8ae9323c7f1ab81ef52aaa2641b194d3be505f4
2013-07-01 18:14:19 +10:00
.tx
Add slicing tool to the master branch
2013-03-14 10:53:54 +08:00
doc/src/docbkx
Fix computefilter/imagefilter confusion
2013-07-01 18:14:19 +10:00
tools
Validate presence of xml:id in section
2013-05-24 23:53:17 -04:00
www
fixed index.html and added user guide files
2013-06-06 12:47:37 -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
.htaccess
Updated .htaccess to redirect /developer pages correctly
2013-06-05 11:34:04 -05: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.

View Git Blame Copy Permalink
Description
OpenStack Manuals
Readme 485 MiB
Languages
HTML 79.7%
CSS 11.4%
Python 4.6%
JavaScript 3.1%
Shell 1.2%