Updated docs, added texts to front page.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/f0806423 Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/f0806423 Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/f0806423 Branch: refs/heads/master Commit: f0806423c7e3eb35e4f58da5baa6543f4c6c07ab Parents: 3854cc2 Author: anatole <anat...@apache.org> Authored: Wed Mar 16 22:51:38 2016 +0100 Committer: anatole <anat...@apache.org> Committed: Wed Mar 16 22:51:38 2016 +0100 ---------------------------------------------------------------------- src/site/asciidoc/userguide/API.adoc | 25 --------------- src/site/asciidoc/userguide/Core.adoc | 10 +++--- .../asciidoc/userguide/HighLevelDesign.adoc | 25 +-------------- src/site/markdown/index.md | 32 ++++++++++++++++---- src/site/site.xml | 2 +- 5 files changed, 32 insertions(+), 62 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/f0806423/src/site/asciidoc/userguide/API.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/userguide/API.adoc b/src/site/asciidoc/userguide/API.adoc index be3cc38..b79790e 100644 --- a/src/site/asciidoc/userguide/API.adoc +++ b/src/site/asciidoc/userguide/API.adoc @@ -35,33 +35,8 @@ Apache Tamaya -- API ''' <<< - -image::http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png[] - toc::[] - <<< -:numbered!: ------------------------------------------------------------ -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. ------------------------------------------------------------ - -:numbered: [[CoreDesign]] == The Tamaya Core Design http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/f0806423/src/site/asciidoc/userguide/Core.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/userguide/Core.adoc b/src/site/asciidoc/userguide/Core.adoc index f45356e..b7a66b4 100644 --- a/src/site/asciidoc/userguide/Core.adoc +++ b/src/site/asciidoc/userguide/Core.adoc @@ -1,5 +1,5 @@ -Apache Tamaya -- Core -===================== +Apache Tamaya -- Core Implementation +==================================== :name: Tamaya :rootpackage: org.apache.tamaya.core :title: Apache Tamaya Core @@ -35,15 +35,13 @@ Apache Tamaya -- Core ''' <<< -image::http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png[] toc::[] <<< -:numbered!: -<<< + [[Core]] -== Tamaya Core +== Tamaya Core Implementation === Overview Tamaya Core provides an implementation of the link:API.html[Tamaya Configuration API] and adds additional functionality http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/f0806423/src/site/asciidoc/userguide/HighLevelDesign.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/userguide/HighLevelDesign.adoc b/src/site/asciidoc/userguide/HighLevelDesign.adoc index a0c255b..0f10890 100644 --- a/src/site/asciidoc/userguide/HighLevelDesign.adoc +++ b/src/site/asciidoc/userguide/HighLevelDesign.adoc @@ -36,32 +36,9 @@ Apache Tamaya -- High Level Design <<< -image::http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png[] - toc::[] <<< -:numbered!: ------------------------------------------------------------ -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. ------------------------------------------------------------ - -:numbered: [[Core Concepts]] == The Tamaya Core Parts @@ -101,7 +78,7 @@ functionality you want. E.g. modules are providing features such as All the mentioned artifacts are used to organize configuration in a higly flexible and extendable way. Hereby the +PropertySource+ is the key artifact. In general Tamaya organizes Configuration as follows: -image::CoreDesign.png[] +image::../images/CoreDesign.png[] Key abstraction hereby is the +ConfigurationContext+, which basically http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/f0806423/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md index 9ce5bc2..238ad58 100644 --- a/src/site/markdown/index.md +++ b/src/site/markdown/index.md @@ -8,22 +8,42 @@ powerful environment model and a flexible SPI. ## Features -TDB +* Unified Configuration API +* Pluggable Configuration Backends +* Enforceable Configuration Policies +* Configuration Validation and Documentation +* Seemless Enterprise Integration ## Documentation -Docu. Docu. Docu. Docu. -Docu. Docu. Docu. Docu. -Docu. Docu. Docu. Docu. +* [Use Cases](userguide/usecases.html) +* [High Level Design](userguide/HighLevelDesign.html) +* [API](userguide/API.html) +* [Extensions](extensions/index.html) --- ## Quickstart -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Using Apache Tamaya is simple: + +1. Add `org.apache.tamaya:tamaya-core:${{project.version}}` to your dependencies. +2. Add your config to `META-INF/javaconfiguration.properties` +3. Access your configuration by `ConfigurationProvider.getConfiguration()` and use it. +4. Look at the [extension modules](extensions/index.html) to customize your setup! +5. Enjoy! ## Rationale -Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +Configuration is one of the most prominent cross-cutting concerns similar to logging. Most of us already have been +writing similar code again and again in each of our projects. Sometimes in a similar way but mostly always slightly +different, but certainly with high coupling to your configuration backends. Given your code is reused or integrated +some how, or deployed by some customers, struggling starts: not supported backends, different policies, missing +combination and validation mechanisms and so on. Tamaya solves all this by defining a common API and backend SPI. +Your code is decoupled from the configuratoin backend. There is no difference if you are running on your dev box +or in a clustered Docker environment in production, your code stays the same! There is no difference if you are writing +some small component or a complete product solution, your API to your configuration data stays the same! Once you +use Tamaya you will ask yourself why this did not exist before... + http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/f0806423/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 6cf5a5f..aab4821 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -49,7 +49,7 @@ under the License. <item name="Sources" href="source.html"/> <item name="Community" href="community.html"/> <item name="Issues" href="https://issues.apache.org/jira/browse/TAMAYA"; target="_blank"/> - <item name="Development Guide" href="devguide/"/> + <item name="Development Guide" href="devguide/index.html"/> <item name="Release Guide" href="release-guide.html"/> </menu>
