openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
4,357 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
5b00b10e46
Go to file
Jenkins 5b00b10e46 Merge "Fix the path of memcached config file"
2014-01-02 16:18:14 +00:00
.tx Update Transifex config for new guide titles 2013-10-11 15:08:38 +11:00
doc Merge "Fix the path of memcached config file" 2014-01-02 16:18:14 +00:00
tools Renames instance_type to flavor in baremetal virt driver 2013-12-30 16:41:17 +00:00
www Publish training-guides publicly 2013-12-30 16:02:35 +01:00
.gitignore Setup for openstack-doc-tools 2013-12-31 17:38:46 +01: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 Modernizes the README now that we have Foundation membership 2013-12-11 12:19:56 -06:00
test-requirements.txt Setup for openstack-doc-tools 2013-12-31 17:38:46 +01:00
tox.ini Setup for openstack-doc-tools 2013-12-31 17:38:46 +01:00

README.rst

OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation wiki page.

It includes these manuals:

  • Installation Guides
  • Cloud Administrator Guide
  • High Availability Guide
  • Security Guide
  • Virtual Machine Image Guide
  • End User Guide
  • Admin User Guide
  • Training Guides

In addition to the guides, this repository contains:

  • docs.openstack.org: www
  • tools for gating tests prior to merging documentation in this repo

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/ directory.

For example, the root directory of the OpenStack User Guide is openstack-manuals/doc/user-guide.

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/user-guide/
mvn clean generate-sources

The generated PDF documentation file is:

openstack-manuals/doc/user-guide/target/docbkx/webhelp/user-guide.pdf

The root of the generated HTML documentation is:

openstack-manuals/doc/src/user-guide/target/docbkx/webhelp/user-guide/content/index.html

Contributing

Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation. The best way to get involved with the community is to talk with others online or at a meetup and offer contributions through our processes, 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.