openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
8,558 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
f523f60a0b
Go to file
KATO Tomoyuki f523f60a0b Update Japanese web page for new design 
Change-Id: Ie6ca4760d0d3f29bdb9d2e0b4a285ec30f7595a7
2015-02-14 20:26:24 +09:00
.tx Update transifex setup for hot-reference 2014-10-03 22:21:00 +02:00
doc Merge "Adds build information for using new openstackdocs theme" 2015-02-14 10:27:52 +00:00
tools Update Telemetry config reference 2015-02-09 10:47:25 +01:00
www Update Japanese web page for new design 2015-02-14 20:26:24 +09:00
.gitignore Use a static site generator to generate content in www 2014-08-14 10:02:26 +02:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
doc-test.conf Remove obsolete entries from doc-test.conf 2014-06-29 15:23:33 +02:00
doc-tools-check-languages.conf Build Simplified Chinese Guides 2015-02-01 06:44:15 +00:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
projects.txt Don't sync to training-guides 2015-01-28 09:31:35 +00:00
README.rst Update Guides in README 2014-10-29 08:48:25 +01:00
test-requirements.txt Adds build information for using new openstackdocs theme 2015-02-11 14:06:57 -06:00
tox.ini Adds build information for using new openstackdocs theme 2015-02-11 14:06:57 -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:

  • Admin User Guide
  • Architecture Design Guide
  • Cloud Administrator Guide
  • Command-Line Interface Reference
  • Configuration Reference
  • End User Guide
  • Heat Orchestration Template reference
  • HOT Guide
  • Installation Guides
  • 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.

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/user-guide/target/docbkx/webhelp/user-guide/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 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.