← Back to branch summary

~johannes.erdfelt/openstack-manuals/path-fixes

« back to all changes in this revision

Viewing changes to doc/source/docbkx/docbkx-example/README

  • Committer: Anne Gentle
  • Date: 2011-08-24 17:52:44 UTC
  • Revision ID: anne@openstack.org-20110824175244-de6ri2to76f55l8e
Adding a generic project to use as a template when starting a new documentation deliverable

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/docbkx/docbkx-example/README
 
1
README
 
2
 
 
3
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. 
 
4
 
 
5
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.
 
6
 
 
7
To build the output, install Apache Maven (https://maven.apache.org/) and then run:
 
8
 
 
9
mvn clean generate-sources 
 
10
 
 
11
in the directory containing the pom.xml file. 
 
12
 
 
13
Feel free to ask questions of the openstack-docs team at https://launchpad.net/~openstack-doc. 
 
 
b'\\ No newline at end of file'