f174fc2caa
This patch reviews the "Answer to the debconf" things in every service, so that they look the same. It also adds links to the debconf chapter, so that users can navigate more easily in the doc. It also changes the titles of the debconf chapter so that they match the text in each chapter. It also documents the fact that python-argparse should be installed manually on all Wheezy setups, which is an issue that has been reported by some users, and which wasn't documented. The patch also extends the explanations about the meta-packages. This patch adds a lot of <informalfigure> tags that were missing as well. Finally, the patch also moves the explanation about remote MySQL setup from the nova installation procedure to the debconf-dbconfig-common section of the debconf chapter, which is a much better fit. This is my last clean-up work, I believe. Change-Id: I5a85f39e49786ae90cc0afbf13b94baf486408f4 backport: havana
Openstack Manuals
This repository contains the cloud administrator documentation for the OpenStack project. It includes documentation for:
- OpenStack Compute
- OpenStack Identity Service
- OpenStack Image Service
- OpenStack Object Storage
- OpenStack Dashboard
- OpenStack Network Connectivity
- OpenStack Volumes
For more details, see the OpenStack Documentation HowTo wiki page.
In addition to the guides, this repository contains:
- docs.openstack.org:
www- tools for gating tests prior to merging documentation in this repo
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 mavenOn Fedora 15 and later:
yum install maven3Building
The different manuals are in subdirectories of the
openstack-manuals/doc/ directory.
For example, the root directory of the OpenStack User Guide
is openstack-manuals/doc/user-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/user-guide/
mvn clean generate-sourcesThe generated PDF documentation file is:
openstack-manuals/doc/user-guide/target/docbkx/webhelp/user-guide.pdfThe root of the generated HTML documentation is:
openstack-manuals/doc/src/user-guide/target/docbkx/webhelp/user-guide/content/index.htmlContributing
Our community welcomes all people interested in open source cloud
computing, and there are no formal membership requirements. The best way
to join the community is to talk with others online or at a meetup 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.
Installing
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.