# Maven Example Documentation

Badges! We don't need any stinking badges!
2011 Timothy D. Witham
Example v0.1
Product Name Doesn't Exist - it's an example!™
2011-01-01
Copyright details are filled in by the template. Change the value of the role attribute on the legalnotice element to change the license.

This document is intended for individuals who whish to produce documentation using Maven and having the same "feel" as the documentation that is produced by the mainline OpenStack projects.

this is a placeholder for the front cover

this is a placeholder for the back cover

## Overview

Welcome to the getting started with Maven documentation. Congratulations you have successfully downloaded and built the example.

For more details on the Product Name service, please refer to http://www.rackspacecloud.com/cloud_hosting_products/product name

We welcome feedback, comments, and bug reports at support@rackspacecloud.com.

### Intended Audience

This guide is intended to individuals who want to develop standalone documentation to use within an OpenStack deployment. Using this tool chain will give you the look and feel of the mainline OpenStack documentation.

### Document Change History

This version of the Maven Getting Started Guide replaces and obsoletes all previous versions. The most recent changes are described in the table below:

Revision Date | Summary of Changes
July. 14, 2011 | Initial document creation.

### Additional Resources

- Openstack - Cloud Software

- Docbook Main Web Site

- Docbook Quick Reference

## Concepts

Need to put something here.

## How do I?

### Notes and including images

So I want an note and an image in this section ...

This is an example of a note.

Here's a sample figure in svg and png formats:

Sample Image

### Multiple Related Documents

What you need to do in order to have multiple documents fit within the build structure.

### Using multiple files for a document

What you need to do in order to have a single document that is made up of multiple files.

### Who, What, Where, When and Why of pom.xml

You will of noticed the pom.xml file at the root directory. This file is used to set the project parameters for the documentation. Including what type of documentation to produce and any post processing that needs to happen. If you want to know more about pom.xml - need a link then follow the link.

For the pom.xmlfile that was included in this distribution we will parse the individual lines and explaine the meaning.

#### <project>

What is all of this stuff and why is it important?

#### <modelVersion>

What goes in here and why?

#### <groupId>

What goes in here and why?

#### <artifactId>

What goes in here and why?

#### <version>

What goes in here and why?

#### <packaging>

What goes in here and why?

#### <name>

Name of your document.

#### <build>

Make some documents.

##### <plugin(s)>

What does this do and why?

###### <groupId>

What goes in here and why?

###### <artifactId>

What goes in here and why?

###### <execution(s)>

What goes in here and why?

###### <goal(s)>

Different types of goals and why you use them.

###### <phase>

What does this section do? What phases can you specify.

###### <configuration>

What does this section do?

###### <xincludeSupported>

What does this do and why?

###### <chunkSectionDepth>

What does this do and why?

###### <postprocess>

What does this section do? What are possible pieces?

###### <copy>

What does this section do? What are possible pieces?

###### <fileset>

What does this section do? What are possible pieces?

###### <include>

What does this section do? What are possible pieces?

### Who, What, Where, When and Why of build.xml

You will of noticed the build.xml file at the root directory. This file is used to set the project parameters for the documentation. Including what type of documentation to produce and any post processing that needs to happen. If you want to know more about pom.xml - need a link then follow the link.

## Troubleshooting

Sometimes things go wrong...