There is several documentation available:
Other interesting links, especially related to configuration on Java:
The documentation is managed as part of the Tamaya Source
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
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
If you would like to submit a documentation patch through Jira, you can have a look at the suggested approach.
If you're a committer and want to publish the documentation at Tamaya Site you have do the following steps:
Currently integration of asciidoc with the site is still a manual process, so
After log in to https://cms.apache.org/tamaya/publish and click on the Submit
button.