openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
3,077 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
40a73e6db8
Go to file
Andreas Jaeger 40a73e6db8 Build all Install Guides and HA Guide in gates 
Build books the same way we build them for publishing:

Build all three variants of the Install Guides if we check building.
Since we introduce os specific sections, the guide might build for one
variant but not the others.

In case of failure, the variant is shown like:
Building all queued 1 books now...
>>> Build of book install-guide (for Ubuntu) failed (returncode = 1).

Also, generate the xml file for the HA guide and build it.

Add generated file bk-ha-guide.xml to .gitignore

Add parameter -B for building to mvn to silence download progress

Run test.py and validate.py through pep8 and fix any issues

Change-Id: Icfb4587e7c08050d1b65dddc5a3a810a8bf12f5a
2013-10-01 08:58:02 +02:00
.tx Add slicing tool to the master branch 2013-03-14 10:53:54 +08:00
doc training, add submit a bug URL to footer of editing code pages 2013-09-30 11:22:10 -07:00
tools Build all Install Guides and HA Guide in gates 2013-10-01 08:58:02 +02:00
www Merge "Do not mention Network Guide anymore, fix name of Cloud Admin Guide" 2013-09-24 17:12:44 +00:00
.gitignore Build all Install Guides and HA Guide in gates 2013-10-01 08:58:02 +02: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 Updates README to reflect current directory structure 2013-09-11 21:16:50 -05: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
  • OpenStack Volumes

For more details, see the OpenStack Documentation HowTo wiki page.

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