openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
4,281 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
eefd494d0b
Go to file
nerminamiller eefd494d0b Move Networking scenarios section from Configuration Reference to Cloud Admin Guide 
Moved networking-config-identity, networking-scenarios,
networking-adv-config, networking-multi-dhcp-agents from Config Ref to
Networking ch of Cloud Admin Guide

Change-Id: I1c14e9b7017fee976c2c80b6f0c8c7bcb15eb046
backport: none
Closes-Bug: #1255295
author: nermina miller
2014-01-03 15:49:46 -05:00
.tx Update Transifex config for new guide titles 2013-10-11 15:08:38 +11:00
doc Move Networking scenarios section from Configuration Reference to Cloud Admin Guide 2014-01-03 15:49:46 -05:00
tools Remove deprecated num_iscsi_scan_tries option 2013-12-20 11:16:00 +08:00
www Adds precise redirects for old CLI quick-start to user-guide 2013-12-19 21:42:00 -06:00
.gitignore Modified GitIgnore File for Vagrant 2013-10-19 22:18:33 +05:30
.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

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.