3bb9c6fc97
Release notes are version independent, so remove version/release values. We've found that projects now require the service package to be installed in order to build release notes, and this is entirely due to the current convention of pulling in the version information. Release notes should not need installation in order to build, so this unnecessary version setting needs to be removed. This is needed for new release notes publishing, see I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting at http://lists.openstack.org/pipermail/openstack-dev/2017-November/124480.html . Change-Id: Ia6d8fbd7792f87e114caad51bfca2cf0ed3dff3e
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:
- 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 bindepAll guides are in the RST format. You can use tox to
prepare virtual environment and build all guides (HTML only):
$ tox -e docsYou can also build a specific guide.
For example, to build OpenStack Virtual Machine Image Guide, use the following command:
$ tox -e build -- image-guideYou can find the root of the generated HTML documentation at:
doc/image-guide/build/html/index.htmlTo build a specific guide with a PDF file, add a -pdf
option like:
$ tox -e build -- image-guide --pdfThe generated PDF file will be copied to the root directory of the generated HTML documentation.
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 manualtox -e checklang- to build translated manualstox -e linters- to run the niceness teststox -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.