openstack/openstack-manuals
Code Issues Proposed changes
2,401 Commits 4 Branches 2 Tags
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Andreas Jaeger 7f3e118dc0 Security Guide: Markup of links 
The guide does not use markup of links at all, I've started adding
markup to the first chapters. I've also did some minor cleanups I
noticed.

Patch set 2:
Diane, thanks for the review, I've followed all your suggestions.

Patch set 3:
I've fixed the name of the OpenStack Compute Adminstration Guide
everywhere in my patch set.

Patch set 4:
Fix whitespace

Patch set 5:
Fix remaining chapters

Change-Id: I3c11aab2bafadd7f2ee3742fbfcaa7f937102d0d
2013-08-10 20:59:15 +02:00
.tx
Add slicing tool to the master branch
2013-03-14 10:53:54 +08:00
doc/src/docbkx
Security Guide: Markup of links
2013-08-10 20:59:15 +02:00
tools
Add Autogenerate-config-doc code to tools
2013-08-10 09:43:55 +08:00
www
updated index.html to invite users to join the foundation or take the user survey
2013-08-07 10:58:33 -05:00
.gitignore
Ignore vim swap files
2012-10-02 23:21:27 +00: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
Check if Maven is building the docs
2012-10-26 00:49:29 +05:30

README.rst

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:

  • api.openstack.org: doc/src/docbkx/openstack-api-site
  • 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 15 and later:

yum install maven3

Building

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

For example, the root directory of the OpenStack Compute Administration Guide is openstack-manuals/doc/src/docbkx/openstack-compute-admin.

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/src/docbkx/openstack-compute-admin
mvn clean generate-sources

The generated PDF documentation file is:

openstack-manuals/doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/trunk/openstack-compute/admin/os-compute-adminguide-trunk.pdf

The root of the generated HTML documentation is:

openstack-manuals/doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/os-compute-adminguide/content/index.html

Contributing

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 Launchpad, 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.

Description
OpenStack Manuals
Readme 474 MiB
Languages
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%