openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
18,797 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
d7b5e0eaa9
Go to file
daz d7b5e0eaa9 [arch-design] Publish draft Arch Guide to docs.openstack.org 
1. Unpublish the current arch-design and temporarily relocate it to a
"to archive" directory until the archiving structure is available
2. Publish the arch-design-draft to docs.openstack.org
3. Unpublish arch-design-draft from https://docs.openstack.org/draft/

Change-Id: Ida5f237d2edce7a83a24c376c355e2c220bc8c28
Implements: blueprint arch-design-pike
2017-03-08 23:02:35 +00:00
doc [arch-design] Publish draft Arch Guide to docs.openstack.org 2017-03-08 23:02:35 +00:00
releasenotes/source Imported Translations from Zanata 2017-02-25 09:23:02 +00:00
tools [arch-design] Publish draft Arch Guide to docs.openstack.org 2017-03-08 23:02:35 +00:00
www [arch-design] Publish draft Arch Guide to docs.openstack.org 2017-03-08 23:02:35 +00: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
bindep.txt Remove obsolete binary packages from install 2017-02-24 13:27:52 +00:00
CONTRIBUTING.rst Use https instead of http for openstack sites 2017-01-31 07:36:48 +09:00
doc-tools-check-languages.conf [arch-design] Publish draft Arch Guide to docs.openstack.org 2017-03-08 23:02:35 +00:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
projects.txt Stop syncing common to api-site/first-app 2017-02-11 22:04:19 +09:00
README.rst Does not build PDF by default with tox -e docs 2017-03-01 20:20:27 +09:00
test-requirements.txt Add license comment for sphinxmark 2017-02-23 10:46:14 +10:00
tox.ini Does not build PDF by default with tox -e docs 2017-03-01 20:20:27 +09: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 (HTML only):

$ 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

To build a specific guide with a PDF file, add a -pdf option like:

$ tox -e build -- user-guide --pdf

The generated PDF file will be copied to the root directory of the generated HTML documentation.

To install all requirements to execute the commands above, on Linux you can check the output of the bindep command. This tool reports missing requirements for all build targets:

$ tox -e bindep

If you get this message make: xelatex: No such file or directory it means your local environment does not have LaTeX installed. Read Getting LaTeX for instructions.

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 the OpenStack CI 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

The tox command uses the openstack-doc-tools package to run the 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 https://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.