OpenStack Manuals
Go to file
Andreas Jaeger e850cb234f Add api-quick-start translations
Enable the newly imported translations.

This needs openstack-doc-tools 1.10 for publishing to
the correct location of translated api-quick-start.

Update index pages to link to new location.
Disable link to Japanese API guide since it's not published currently
(too few translated strings).

Change-Id: Ie79ce7be7d6c16c9954f50c77f6618c9c2974c3e
2019-07-24 14:21:05 +02:00
doc Imported Translations from Zanata 2019-07-23 08:57:22 +00:00
playbooks/build-manuals-tox Add native zuulv3 set up 2017-10-09 22:07:27 +02:00
releasenotes/source Imported Translations from Zanata 2019-05-28 06:34:18 +00:00
tools Remove firstapp guide 2019-07-22 11:53:19 +02:00
www Add api-quick-start translations 2019-07-24 14:21:05 +02:00
.gitignore www-generator.py: cache expensive repo/project metadata to disk 2019-01-04 17:10:22 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:41:34 +00:00
.pydevproject [config-ref] Update api-paste.ini of manila 2017-04-13 19:38:07 +08:00
.zuul.yaml Update developer jobs 2019-07-22 07:33:06 +00:00
bindep.txt Add missing fonts for pdf build in Sphinx 2.0 2019-04-07 00:45:08 +02:00
CONTRIBUTING.rst [contrib-guide] Updating url to doc-contrib-guide 2017-09-22 14:57:47 +00:00
doc-tools-check-languages.conf Add api-quick-start translations 2019-07-24 14:21:05 +02:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
projects.txt Sync common files to ops and ha guides 2018-11-23 06:21:34 +01:00
README.rst Add release note in README 2018-07-17 22:14:41 +08:00
test-requirements.txt Add api-quick-start translations 2019-07-24 14:21:05 +02:00
tox.ini Cleanup after api-quick-start import 2019-07-17 11:08:28 +02:00

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.