OpenStack Manuals

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

OpenStack Proposal Bot 64f75c2ec9 Imported Translations from Zanata For more information about this automatic import see: https://wiki.openstack.org/wiki/Translations/Infrastructure Change-Id: I5c89a9cbb141c681e4c06fc1491bf9ba50d7d0de		7 years ago
doc	Imported Translations from Zanata	7 years ago
releasenotes/source	[relnotes] [networking] Release notes for Newton	7 years ago
tools	Add Hitachi HSP Share Driver Documentation	7 years ago
www	Use new OpenStack logos	7 years ago
.gitignore	Add "*.swo" to ".gitignore" file	7 years ago
.gitreview	Add .gitreview config file for gerrit.	12 years ago
LICENSE	bug 944097 adding apache license to openstack-manuals repo	11 years ago
README.rst	Show team and repo badges on README	7 years ago
bindep.txt	Add libfreetype as pillow dependency	7 years ago
doc-tools-check-languages.conf	Add zh_CN user guide	7 years ago
projects.txt	[ha-guide] Changes after ha-guide is merged to manuals	7 years ago
test-requirements.txt	Sync requirements with global requirements	7 years ago
tox.ini	Test that glossary is sorted	7 years ago

README.rst

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.

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.