openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
15,060 Commits 4 Branches 2 Tags 472 MiB
HTML 77.1%
CSS 13%
Python 5%
JavaScript 3.5%
Shell 1.4%
Go to file
Andreas Jaeger a93ed3809b Switch output to publish-docs/html 
Publishing to a top-level directory has a few challenges with some new
infra scripts. Let's keep those simple and change from publish-docs to
publish-docs/html.

this backports and adjust changes:
https://review.opendev.org/676913
https://review.opendev.org/676483
https://review.opendev.org/676482
https://review.opendev.org/676960

fix also git.openstack.org links so that guides build.

Depends-On: https://review.opendev.org/676489
Change-Id: I94b7bf915c0fdad0e9e2f5dd81846f45dc99194a
 		2019-08-16 16:35:57 +02:00
doc Switch output to publish-docs/html 2019-08-16 16:35:57 +02:00
releasenotes Huawei: Update huawei cinder driver configuration file for mitaka. 2017-03-16 12:22:28 +00:00
tools Switch output to publish-docs/html 2019-08-16 16:35:57 +02:00
www [www] Update Summit Videos URL 2016-05-02 01:25:51 +00:00
.gitignore Convert glossary to RST 2016-05-02 09:20:30 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:41:38 +00:00
.zuul.yaml Switch output to publish-docs/html 2019-08-16 16:35:57 +02:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Trivial whitespace change to trigger publishing 2017-11-28 20:39:16 +01:00
doc-test.conf Update building for mitaka 2016-05-04 19:53:59 +02:00
doc-tools-check-languages.conf Build German Install Guide 2017-02-02 12:26:42 +00:00
other-requirements.txt Add libfreetype as pillow dependency 2016-10-19 09:08:24 +02:00
projects.txt Stop syncing to operations-guide 2016-04-29 18:31:37 -05:00
test-requirements.txt Switch output to publish-docs/html 2019-08-16 16:35:57 +02:00
tox.ini Switch output to publish-docs/html 2019-08-16 16:35:57 +02:00

README.rst

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
  • Installation Guides
  • 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

Various guides are in the RST format. You can use tox to prepare virtual environment and build all RST based guides:

tox -e docs

You can also build a specific guide. For example, to build the 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

Glossary

Apache Maven must be installed to build the glossary.

To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:

apt-get install maven

On Fedora 20 and later:

yum install maven

On openSUSE Leap:

zypper ar http://download.opensuse.org/repositories/devel:/tools:/building/openSUSE_Leap_42.1/devel:tools:building.repo
zypper install maven

To build the glossary, move to doc/glossary, then run the mvn command in that directory:

cd doc/glossary
mvn clean generate-sources

The generated PDF documentation file is:

doc/glossary/target/docbkx/webhelp/glossary/openstack-glossary.pdf

The root of the generated HTML documentation is:

doc/glossary/target/docbkx/webhelp/glossary/content/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 checklinks - to run the tests for working remote URLs
  • tox -e checkniceness - to run the niceness tests
  • tox -e checksyntax - to run syntax checks
  • tox -e checkdeletions - to check that no deleted files are referenced
  • tox -e checkbuild - to actually build the manual
  • tox -e checklang - to build translated manuals

tox will use the openstack-doc-tools package for execution of these tests.

Contributing

Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.

The best way to get involved with the community is to talk with others online or at a meet up and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at #openstack on irc.freenode.net.

We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

If you would like to contribute to the documents, please see the OpenStack Documentation contributor guide.

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.