openstack/openstack-manuals
Code Issues Proposed changes

Added info on how to build docs to the README.

Browse Source 
Added info in the README.rst about how to generate the documentation.

Word-wrapped all text to 78 chars or less.

Now ignores Oxygen XML editor project files (.xpr)

Change-Id: I167605c95c706ac1ef82393aa8301594ced1e01d
This commit is contained in:
Lorin Hochstein 2011-11-20 16:58:41 -05:00
parent 7686400ddb
commit 7e9de9b325
2 changed files with 48 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1,2 +1,3 @@
.DS_STORE?
target/
*.xpr

50
README.rst
View File

@ -1,9 +1,53 @@
This repository contains the cloud administrator documentation for the OpenStack project. It includes documentation for OpenStack Compute, OpenStack Identity Service, OpenStack Image Service, and OpenStack Object Storage as well as the Dashboard.
This repository contains the cloud administrator documentation for the
OpenStack project. It includes documentation for OpenStack Compute, OpenStack
Identity Service, OpenStack Image Service, and OpenStack Object Storage as
well as the Dashboard.
For more details, see the `OpenStack Documentation HowTo wiki page
<http://wiki.openstack.org/Documentation/HowTo>`_.
Prereqs
=======
`Apache Maven <http://maven.apache.org/>`_ must be installed to build the
documentation.
Building
========
To build the Compute Admin Manual, Object Storage Admin Manual, and Image
Service Manual::
cd openstack-manuals/doc
mvn clean generate-sources
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, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
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, or blogs. 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.
Refer to http://docs.openstack.org to see where these documents are published
and to learn more about the OpenStack project.