openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
17,516 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 f80f22b253 Update URL of contributor guide 
Update README.rst to point to current location.

I'm pushing this to check that publishing works since the last run
failed mysteriously.

Change-Id: Ib78625f9e4a2a2b8f6a4a689c06c9c7dec03a10c
 		2019-08-23 21:12:40 +02:00
doc Switch output to publish-docs/html 2019-08-16 16:34:24 +02:00
releasenotes Huawei: update huawei cinder driver configuration file. 2017-03-23 07:28:32 +00:00
tools Switch output to publish-docs/html 2019-08-16 16:34:24 +02:00
www Merge "[www] Do not link to old Japanese Ops Guide" 2016-11-10 11:30:12 +00:00
.gitignore Add "*.swo" to ".gitignore" file 2016-08-09 06:18:46 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:41:42 +00:00
.zuul.yaml Switch output to publish-docs/html 2019-08-16 16:34:24 +02:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Update URL of contributor guide 2019-08-23 21:12:40 +02:00
bindep.txt Add libfreetype as pillow dependency 2016-10-19 08:16:54 +02:00
doc-tools-check-languages.conf [i18n] build Indonesian Networking Guide for Newton 2017-01-19 18:44:58 +09:00
projects.txt [ha-guide] Changes after ha-guide is merged to manuals 2016-05-05 21:12:50 +05:30
test-requirements.txt Update for openstack-doc-tools 2.0 2019-08-22 17:06:02 +02:00
tox.ini Update for openstack-doc-tools 2.0 2019-08-22 17:06:02 +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
  • 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:

$ 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

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 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

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.