Title: Documentation
Notice:    Licensed to the Apache Software Foundation (ASF) under one
           or more contributor license agreements.  See the NOTICE file
           distributed with this work for additional information
           regarding copyright ownership.  The ASF licenses this file
           to you under the Apache License, Version 2.0 (the
           "License"); you may not use this file except in compliance
           with the License.  You may obtain a copy of the License at
           .
             http://www.apache.org/licenses/LICENSE-2.0
           .
           Unless required by applicable law or agreed to in writing,
           software distributed under the License is distributed on an
           "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
           KIND, either express or implied.  See the License for the
           specific language governing permissions and limitations
           under the License.

[TOC]

***

# Available Project Documentation

There is several documentation available:

* The [Project Documentation](documentation/index.html)
* The [Javadocs](javadoc.html)
* The [Examples](examples.html)

Other interesting links, especially related to configuration on Java:

* [The Java EE Configuration Blog by Anatole Tresch](http://javaeeconfig.blogspot.com)
* [The Apache Deltaspike Configuration](http://deltaspike.apache.org/documentation/configuration.html)
* [Presentation on Configuration from JavaOne 2014](http://de.slideshare.net/AnatoleTresch/a-first-drat-to-java-configuration)


# Enhancing Documentation
## Documentation Sources
The documentation is managed as part of the [Tamaya Source](source.html)

## Documentation Format
The format used for Tamaya documentation is [ASCIIDOC](http://www.methods.co.nz/asciidoc/) because it's easily
exportable to PDF, HTML, and it's also easy to contribute. It can be used to export also to epub and also be used to
write books

## Rendering documentation as HTML
_Requirenment:_ Have [Maven](http://maven.apache.org/) installed.

If you cloned the source repository and want to render the documentation as HTML, you just need to run the following command:

    $ cd REPO_ROOT/docs
    $ mvn site

The generate documentation will be available at `REPO_ROOT/docs/target/site`

## Contribute
If you would like to submit a documentation patch through Jira, you can have a look at the
[suggested approach](suggested-git-workflows.html).

## Publish procedure (for committers only)
If you're a committer and want to publish the documentation at [Tamaya Site](http://tamaya.incubator.apache.org/documentation/)
you have do the following steps:

1. Checkout the Tamaya Project Tree from [the project source][1].
2. Edit Documentation in $PROJECT_ROOT/docs
3. Commit changes.

Currently integration of asciidoc with the site is still a manual process, so

4. Checkout the Tamaya Site from <https://svn.apache.org/repos/asf/incubator/tamaya/site/trunk>
5. Generate the Documentation in <docs> with maven package
6. Copy the generated documentation .html files into /docs int the Tamaya site tree and commit the changes to the
   site repo.

After log in to <https://cms.apache.org/tamaya/publish> and click on the `Submit` button.