Documentation

Available Project Documentation¶

There is several documentation available:

• The Project Documentation
• The Javadocs
• The Examples

Other interesting links, especially related to configuration on Java:

• The Java EE Configuration Blog by Anatole Tresch
• The Apache Deltaspike Configuration
• Presentation on Configuration from JavaOne 2014

Enhancing Documentation¶

Documentation Sources¶

The documentation is managed as part of the Tamaya Source

Documentation Format¶

The format used for Tamaya documentation is 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 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.

Publish procedure (for committers only)¶

If you're a committer and want to publish the documentation at Tamaya Site 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

1. Checkout the Tamaya Site from https://svn.apache.org/repos/asf/incubator/tamaya/site/trunk
2. Generate the Documentation in with maven package
3. 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.