openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
18,116 Commits 4 Branches 2 Tags 472 MiB
HTML 77%
CSS 13%
Python 5.1%
JavaScript 3.5%
Shell 1.4%
Go to file
Miguel Lavalle c3ac94c34f Update Networking guide with Placement API config 
Routed networks functionality in the Networking service requires the
communication of IPv4 addresses inventory to the Compute scheduler
using the Placement API. This patchset updates the Networking Guide
with instructions on how to configure the communication with the
Placement API.

Change-Id: I1d7816c9958a3bf2f24a08085587ee12e846783d
Closes-Bug: #1657923
 		2017-01-23 01:43:28 +00:00
doc Update Networking guide with Placement API config 2017-01-23 01:43:28 +00:00
releasenotes/source Imported Translations from Zanata 2017-01-14 08:47:15 +00:00
tools Fixes typo bug1 on hook.py for openstack-manuals 2017-01-20 21:33:27 +07:00
www [www-id] add Indonesian Networking Guide for Newton as draft 2017-01-19 18:57:07 +09: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 Build Japanese ha-guide 2017-01-06 13:25:08 +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 Switch to current Sphinx 2017-01-13 16:36:45 +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.