openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
14,853 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
66375a8ccd
Go to file
Christian Berendt 66375a8ccd Cleanup README file 
* remove deprecated tox environments
* remove deprecated Maven instructions
* cleanup syntax

Change-Id: I6b52a658ebd650f8a300a96d4bca200ba7ce687b
2016-05-18 12:22:16 +02:00
doc Merge "Add missing ml2 section to config reference" 2016-05-17 15:05:26 +00:00
releasenotes/source Imported Translations from Zanata 2016-05-10 06:28:08 +00:00
tools Sync-projects: Copy glossary again 2016-05-10 09:36:12 +02:00
www Remove the invalid zaqarclient documentation url 2016-05-17 19:00:51 +05:30
.gitignore Convert glossary to RST 2016-05-02 09:20:30 +02:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
doc-test.conf New nova policy.json sample 2015-10-07 12:36:46 +02:00
doc-tools-check-languages.conf [ops-guide] Enable translation 2016-05-08 22:04:48 +09:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
other-requirements.txt Install only required packages 2016-03-29 09:50:59 +02:00
projects.txt [ha-guide] Changes after ha-guide is merged to manuals 2016-05-05 21:12:50 +05:30
README.rst Cleanup README file 2016-05-18 12:22:16 +02:00
test-requirements.txt Disable Insecure warnings 2016-03-04 13:14:52 +01:00
tox.ini Remove work around for fix released problem 2016-05-05 19:59:27 +09:00

README.rst

OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation Contributor Guide.

It includes these manuals:

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

In addition to the guides, this repository contains:

  • docs.openstack.org contents: www

Building

Various manuals are in subdirectories of the doc/ directory.

Guides

All guides are in the RST format. You can use tox to prepare virtual environment and build all 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:

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 linkcheck - to run the tests for working remote URLs
  • tox -e checkniceness - to run the niceness tests
  • 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 OpenStack Documentation Contributor Guide.

Generated files

Some documentation files are generated using tools. These files include a do not edit header and should not be modified by hand. Please see Generated files.

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.