openstack-manuals

History

Anne Gentle ba65f6e287 Adds admin manuals for Identity, Image, Compute, and Object Storage Change-Id: I368af8a7b843b1f1cba0d8a2ccdaa0f40634db3d		2011-09-20 08:50:34 -05:00
..
src/docbkx	Adds admin manuals for Identity, Image, Compute, and Object Storage	2011-09-20 08:50:34 -05:00
README	Adds admin manuals for Identity, Image, Compute, and Object Storage	2011-09-20 08:50:34 -05:00
pom.xml	Adds admin manuals for Identity, Image, Compute, and Object Storage	2011-09-20 08:50:34 -05:00

README

README

This docbkx-example folder is provided for those who want to use the maven mojo supplied with the project to build their own documents to PDF and HTML (webhelp) format. It's intended to be a template and model. 

You can edit the src/docbkx/example.xml file using vi, emacs, or another DocBook editor. At Rackspace we use Oxygen. Both Oxygen and XML Mind offer free licenses to those working on open source project documentation.

To build the output, install Apache Maven (https://maven.apache.org/) and then run:

mvn clean generate-sources 

in the directory containing the pom.xml file. 

Feel free to ask questions of the openstack-docs team at https://launchpad.net/~openstack-doc.