Title: Javadoc
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]


***

# Latest version

You can checkout the latest version always from our Apache [source repository][6], or the corresponding [GitHub mirror][7].
For building Apache Tamaya you only need Apache Maven, JDK 7 and JDK 8 being installed.

# Stable Releases

The latest published release is 0.1-incubating.

* Java 8 based version for [API][1] and [Core Implementation][2]
* Java 7 based version for [API][3] and [Core Implementation][4]

# Contribute

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


# Publish procedure (for committers only)

Publishing Javadocs currently is a manual process:

1. Checkout the source tree of Tamaya
2. Checkout the Tamaya site from <https://svn.apache.org/repos/asf/incubator/tamaya/site/trunk>.
3. Generate the Javadocs for all three parts: API, Core and modules and generate it into the according
   locations within the site directory: content/javadoc/api, content/javadoc/core, content/javadoc/modules
4. Commit the changes to the site repo.
5. Log in to <https://cms.apache.org/tamaya/publish> and click on the `Submit` button.


  [1]: javadoc/api/java8
  [2]: javadoc/core/java8
  [3]: javadoc/api/java7
  [4]: javadoc/core/java7
  [5]; source.html
  [6]: http://git-wip-us.apache.org/repos/asf/incubator-tamaya.git
  [7]: https://github.com/apache/incubator-tamaya.git