Go to file

Roger Luethi 946114eb30 labs: pass vm_name as arg to _vbox_configure_ifs

_vbox_configure_ifs should no longer use the environment variable
NODE_NAME as the name of the node VM. It gets replaced by the correct
value passed as an argument.

Change-Id: I9d36420bcf56bbabe2f47cee2d7eb2ad824bf5d1

2014-09-01 17:43:27 +02:00

doc

Merge "Change landsilde theme for right float"

2014-09-01 15:37:53 +00:00

labs

labs: pass vm_name as arg to _vbox_configure_ifs

2014-09-01 17:43:27 +02:00

specs

spec for repository restructure as per books

2014-06-30 22:26:52 +05:30

tools

Setup for translation

2014-08-18 21:05:12 +02:00

.gitignore

labs: don't track Vagrant ssh keys

2014-07-28 10:24:04 +02:00

.gitreview

add .gitreview file

2014-06-11 18:04:08 -07:00

doc-test.conf

Add structure for inital import

2014-05-29 10:32:06 +08:00

doc-tools-check-languages.conf

Setup for translation

2014-08-18 21:05:12 +02:00

LICENSE

Add structure for inital import

2014-05-29 10:32:06 +08:00

README.rst

Update the yum install maven in README

2014-08-12 11:32:16 +00:00

test-requirements.txt

Updated from global requirements

2014-08-18 18:33:47 +00:00

tox.ini

Setup for translation

2014-08-18 21:05:12 +02:00

README.rst

OpenStack Training Guides

This repository contains open source training manuals that can be used to learn about the OpenStack project.

For more details, see the OpenStack Training Guides wiki page.

It includes these guides:

Associate Guide

Operator Guide

Developer Guide

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 20 and later:

yum install maven

Building

The different guides are in subdirectories of the openstack-training-guides/doc/ directory.

To build the guides, look for a pom.xml file within a subdirectory, then run the mvn command in that directory. For example:

cd openstack-training-guides/doc/training-guides/
mvn clean generate-sources

The generated PDF documentation file is:

openstack-training-guides/doc/training-guides/target/docbkx/webhelp/training-guides.pdf

The root of the generated HTML documentation is:

openstack-training-guides/doc/training-guides/target/docbkx/webhelp/training-guides/content/index.html

Testing of changes and building of the manual

Install the python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

tox -e checkniceness - to run the niceness tests

tox -e checksyntax - to run syntax checks

tox -e checkdeletions - to check that no deleted files are referenced

tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests.

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

If you would like to contribute to the documents, please see the Documentation HowTo.

Bugs

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/openstack-training-guides

Installing

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.