openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
20,456 Commits 4 Branches 2 Tags 472 MiB
HTML 77.1%
CSS 13%
Python 5%
JavaScript 3.5%
Shell 1.4%
Go to file
Doug Hellmann 9597c5e596 treat SIG repositories as official 
Repositories managed by SIGs should be treated as official, so include
them when loading the full set of known repositories.

Change-Id: If55dac67542533ddc09e8d998011dccc9b44229d
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
 		2018-08-30 11:06:42 -04:00
doc Merge "Fix a nonexistent link reference" 2018-08-27 11:04:43 +00:00
playbooks/build-manuals-tox Add native zuulv3 set up 2017-10-09 22:07:27 +02:00
releasenotes/source Remove display_badge setting 2018-08-24 12:10:36 +02:00
tools treat SIG repositories as official 2018-08-30 11:06:42 -04:00
www Merge "Change the service details for charm-deployment-guide" 2018-08-29 16:44:53 +00:00
.gitignore Cleanup .gitignore 2017-07-21 20:26:29 +02:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
.pydevproject [config-ref] Update api-paste.ini of manila 2017-04-13 19:38:07 +08:00
.zuul.yaml switch documentation job to new PTI 2018-08-13 16:47:23 -04:00
CONTRIBUTING.rst [contrib-guide] Updating url to doc-contrib-guide 2017-09-22 14:57:47 +00:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Add release note in README 2018-07-17 22:14:41 +08:00
bindep.txt Add python3 to bindep 2018-07-09 09:08:00 +02:00
doc-tools-check-languages.conf [contrib-guide] Updating url to doc-contrib-guide 2017-09-22 14:57:47 +00:00
projects.txt Stop syncing common to api-site/first-app 2017-02-11 22:04:19 +09:00
test-requirements.txt Remove display_badge setting 2018-08-24 12:10:36 +02:00
tox.ini switch the build to use python3 2018-06-28 15:31:10 -04: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:

  • Architecture Design Guide
  • Documentation Contributor Guide
  • High Availability Guide
  • Installation 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

Some pre-requisites are needed to build the guides. If you are using a Linux operating system you can generate a report of missing local requirements with the bindep command:

$ tox -e bindep

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 Virtual Machine Image Guide, use the following command:

$ tox -e build -- image-guide

You can find the root of the generated HTML documentation at:

doc/image-guide/build/html/index.html

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

$ tox -e build -- image-guide --pdf

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

PDF builds are accomplished using LaTeX as an intermediate format. Currently, you can generate a PDF file for a limited number of guides. The supported list is maintained in the tools/build-all-rst.sh file.

If you get the error message make: xelatex: No such file or directory, it means your local environment does not have LaTeX installed. Read Getting LaTeX and Install dependencies for building documentation for instructions.

Testing of changes and building of all manuals

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; this also generates a directory publish-docs that contains the built files for inspection
  • tox -e checklang - to build translated manuals
  • tox -e linters - to run the niceness tests, for example, to see extra whitespaces
  • 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

Release Notes

https://docs.openstack.org/releasenotes/openstack-manuals

Installing

Refer to https://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.