openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
17,872 Commits 4 Branches 2 Tags 472 MiB
HTML 77.1%
CSS 13%
Python 5%
JavaScript 3.5%
Shell 1.4%
Go to file
Anne Gentle 44efc50ac5 Adds new CONTRIBUTING.txt and updates README.rst 
* In response to openstack-dev ML thread at
http://lists.openstack.org/pipermail/openstack-dev/2016-December/109294.html
* Proof-of-concept that we would get both a GitHub UI addition of a linked
CONTRIBUTING file as well as a Sphinx include directive in the more detailed
contributor guide.

Change-Id: Ibe4c46faa25697eac4819d8ff1b2722fe58f23bf
 		2017-01-11 11:47:29 +00:00
doc Merge "Add "\" to make the command correct" 2017-01-02 10:28:25 +00:00
releasenotes/source Fix broken URLs 2016-12-28 15:18:05 +01:00
tools [config-ref] update cinder kaminario config tables 2016-12-27 09:42:57 +09:00
www Remove broken redirect 2016-12-29 19:41:52 +01:00
.gitignore Add "*.swo" to ".gitignore" file 2016-08-09 06:18:46 +00:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
CONTRIBUTING.rst Adds new CONTRIBUTING.txt and updates README.rst 2017-01-11 11:47:29 +00:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Adds new CONTRIBUTING.txt and updates README.rst 2017-01-11 11:47:29 +00:00
bindep.txt PDF generation support with --pdf option 2016-12-01 21:55:40 +00:00
doc-tools-check-languages.conf Add zh_CN user guide 2016-11-02 10:53:25 +01:00
projects.txt [ha-guide] Changes after ha-guide is merged to manuals 2016-05-05 21:12:50 +05:30
test-requirements.txt Blacklist broken lxml release 2016-12-23 10:00:52 +01:00
tox.ini Test that glossary is sorted 2016-11-14 16:43:19 +01:00

README.rst

Team and repository tags

image

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 Tutorials
  • 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 checkbuild - to actually build the manual
  • tox -e checklang - to build translated manuals
  • tox -e checkniceness - to run the niceness tests
  • tox -e linkcheck - to run the tests for working remote URLs

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

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.