openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
12,901 Commits 4 Branches 2 Tags 472 MiB
HTML 77.1%
CSS 13%
Python 5%
JavaScript 3.5%
Shell 1.4%
Go to file
Steven Hardy 98ef59a599 [install] Fix heat trustee configuration 
The current example config is broken with the default deferred
authentication of trusts - the project_domain_id and project_name
cannot be specified in this section or keystone will throw a
"cannot be scoped to multiple targets" error when we attempt to get
a token scoped to a trust.

Also, the auth_uri is unused by the keystoneclient password auth
plugins, so remove it (it has been a source of confusion in the
referenced bug).

Change-Id: I6305be3c693993de4d16d82fd6de936e92c437c5
Closes-Bug: #1300246
Backport: liberty
 		2015-12-07 11:42:12 -07:00
doc [install] Fix heat trustee configuration 2015-12-07 11:42:12 -07:00
tools [config-ref] Update the tables for manila hnas 2015-12-05 11:30:43 +01:00
www [www-cs] Build Czech install guide as draft 2015-12-04 16:58:55 +09:00
.gitignore Revert "Add reno for release-notes" 2015-11-10 14:49:13 +00: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 Update guides in README.rst 2015-11-29 06:35:22 +00:00
RELEASENOTES.rst [arch-design] Move RST guide to arch-design folder 2015-11-27 13:14:01 +09:00
doc-test.conf New nova policy.json sample 2015-10-07 12:36:46 +02:00
doc-tools-check-languages.conf Do not translate cli-reference 2015-12-05 08:22:04 +01:00
projects.txt Copy RST files to ha-guide and api-site 2015-05-01 17:27:28 +02:00
test-requirements.txt Revert "Add reno for release-notes" 2015-11-10 14:49:13 +00:00
tox.ini Revert "Add reno for release-notes" 2015-11-10 14:49:13 +00: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:

  • Admin User Guide
  • Architecture Design Guide
  • Cloud Administrator Guide
  • Command-Line Interface Reference
  • Configuration Reference
  • Documentation Contributor Guide
  • End User Guide
  • Installation Guides
  • Networking Guide
  • Virtual Machine Image Guide

In addition to the guides, this repository contains:

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

yum install maven

On openSUSE 13.1 and later:

zypper ar http://download.opensuse.org/repositories/devel:/tools:/building/openSUSE_13.1/devel:tools:building.repo
zypper install maven

Building

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

DocBook guides

For example, the root directory of the OpenStack Virtual Machine Image Guide is openstack-manuals/doc/image-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/image-guide/
mvn clean generate-sources

The generated PDF documentation file is:

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

The root of the generated HTML documentation is:

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

RST guides

Then, you can see some guides written in the RST format, so we can't use mvn command. You can use tox to prepare virtual environment and build all RST based guides:

tox -e docs

You can also build a specific guide. For example, to build OpenStack End User Guide, use the following command:

tox -e build -- user-guide

You can find the root of the generated HTML documentation at:

openstack-manuals/doc/user-guide/build/html/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 checklinks - to run the tests for working remote URLs
  • 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 -e checklang - to build translated manuals

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

Installing

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