openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
11,027 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 0c8798bf2d Add linkcheck for RST 
Check RST files for valid links.

This is a separte target for now to evaluate how useful it is.
Whitelist build.opensuse.org URL for user-guide.
Remove also checklang from default tox invocation since it's not needed
to run by default.

Change-Id: I6c275518b9e55ab3b6bcea52894ea851924bee94
 		2015-08-25 06:29:37 +02:00
.tx Moving .rst format files to main admin-guide-cloud folder 2015-08-21 09:37:08 +02:00
doc Add linkcheck for RST 2015-08-25 06:29:37 +02:00
tools Add linkcheck for RST 2015-08-25 06:29:37 +02:00
www Merge "Update sitemap.xml file" 2015-08-23 09:12:07 +00:00
.gitignore Remove DocBook XML files for Install Guide 2015-08-19 16:35:31 +02:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Remove DocBook XML files for Install Guide 2015-08-19 16:35:31 +02:00
doc-test.conf Grammar/phrasal mistakes: OS Virtual Machine Image Guide 2015-05-19 08:59:51 +02:00
doc-tools-check-languages.conf Moving .rst format files to main admin-guide-cloud folder 2015-08-21 09:37:08 +02:00
projects.txt Copy RST files to ha-guide and api-site 2015-05-01 17:27:28 +02:00
test-requirements.txt User Guides: Enable translations 2015-05-13 22:13:41 +02:00
tox.ini Add linkcheck for RST 2015-08-25 06:29:37 +02:00

README.rst

OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation wiki page.

It includes these manuals:

  • Admin User Guide
  • Architecture Design Guide
  • Cloud Administrator Guide
  • Command-Line Interface Reference
  • Configuration Reference
  • End User Guide
  • Heat Orchestration Template reference
  • HOT Guide
  • Installation Guides
  • Virtual Machine Image Guide

In addition to the guides, this repository contains:

  • docs.openstack.org: www

Prerequisites

Apache Maven must be installed to build the documentation.

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 13.1 and later:

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

Building

The different manuals are in subdirectories of the openstack-manuals/doc/ directory.

DocBook guides

For example, the root directory of the OpenStack Virtual Machine Image Guide is openstack-manuals/doc/image-guide.

To build a specific guide, look for a pom.xml file within a subdirectory, then run the mvn command in that directory. For example:

cd openstack-manuals/doc/image-guide/
mvn clean generate-sources

The generated PDF documentation file is:

openstack-manuals/doc/image-guide/target/docbkx/webhelp/image-guide/image-guide.pdf

The root of the generated HTML documentation is:

openstack-manuals/doc/image-guide/target/docbkx/webhelp/image-guide/content/index.html

RST guides

Then, you can see that the openstack-manuals/doc/user-guides is the RST based guide, So we can't use mvn command. You can use tox to prepare virtual environment and build it:

tox -e docs

The root of the generated End User Guide HTML documentation is:

openstack-manuals/doc/user-guides/build/html/index.html

The root of the generated Admin User Guide HTML documentation is:

openstack-manuals/doc/user-guides/build-admin/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 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 Documentation HowTo.

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.