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

2.4 KiB

Raw Blame History

Team and repository tags

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.

2.4 KiB Raw Blame History