You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by an...@apache.org on 2016/03/17 01:28:39 UTC
[08/11] incubator-tamaya git commit: Moved all docs to site part.
Removed some of the file hierarchies for getting things work.
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/userguide/uc/value-placeholders.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/userguide/uc/value-placeholders.adoc b/src/site/asciidoc/userguide/uc/value-placeholders.adoc
deleted file mode 100644
index 57857a8..0000000
--- a/src/site/asciidoc/userguide/uc/value-placeholders.adoc
+++ /dev/null
@@ -1,8 +0,0 @@
-=== Value Placeholders
-
-Users just want to to be able to add placeholders to the values of configuration (not the keys). The mechanisms for
-resolving the placeholders hereby should be not constraint to one single lanmguage like EL. Instead of different
-replacement strategies should be selectable, e.g. by prefixing an expression with the name of the resolver that
-should do the work (eg +"blabla ${env:HOME} using Java version ${sys:java.version}."+.
-This allows resolution mechanism to be isolated easily and also allows to use simpler mechanisms, if no more complex
-ones like EL are required. This is especially useful to deal with low resource environment like ME.
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/userguide/usecases.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/userguide/usecases.adoc b/src/site/asciidoc/userguide/usecases.adoc
deleted file mode 100644
index fa6b8df..0000000
--- a/src/site/asciidoc/userguide/usecases.adoc
+++ /dev/null
@@ -1,58 +0,0 @@
-= Apache Tamaya -- Use Cases
-:name: Tamaya
-:rootpackage: org.apache.tamaya
-:title: Apache Tamaya
-:revnumber: 0.1-SNAPSHOT
-:revremark: Incubator
-:revdate: November 2014
-:longversion: {revnumber} ({revremark}) {revdate}
-:authorinitials: OBF
-:author: Oliver B. Fischer
-:email: <pl...@apache.org>
-:source-highlighter: coderay
-:website: http://tamaya.incubator.apache.org/
-:toc:
-:toc-placement: manual
-:encoding: UTF-8
-: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.
-toc::[]
-
-
-== Use Cases
-
-include::src/site/asciidoc/userguide/uc/simple-access.adoc[]
-include::src/site/asciidoc/userguide/uc/simple-property-access.adoc[]
-include::src/site/asciidoc/userguide/uc/value-placeholders.adoc[]
-include::src/site/asciidoc/userguide/uc/type-safe-properties.adoc[]
-include::src/site/asciidoc/userguide/uc/templates.adoc[]
-include::src/site/asciidoc/userguide/uc/java8.adoc[]
-include::src/site/asciidoc/userguide/uc/locations.adoc[]
-include::src/site/asciidoc/userguide/uc/formats.adoc[]
-include::src/site/asciidoc/userguide/uc/multiple-configurations.adoc[]
-include::src/site/asciidoc/userguide/uc/external-configuration.adoc[]
-include::src/site/asciidoc/userguide/uc/context-dependent-configuration.adoc[]
-include::src/site/asciidoc/userguide/uc/dynamic-provisioning.adoc[]
-include::src/site/asciidoc/userguide/uc/minimal-propertysource.adoc[]
-include::src/site/asciidoc/userguide/uc/scannable-properties.adoc[]
-include::src/site/asciidoc/userguide/uc/combine-configs.adoc[]
-include::src/site/asciidoc/userguide/uc/management.adoc[]
-include::src/site/asciidoc/userguide/uc/service-context.adoc[]
-include::src/site/asciidoc/userguide/uc/injection.adoc[]
-
-
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 238ad58..01b504f 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -16,10 +16,10 @@ powerful environment model and a flexible SPI.
## Documentation
-* [Use Cases](userguide/usecases.html)
-* [High Level Design](userguide/HighLevelDesign.html)
-* [API](userguide/API.html)
-* [Extensions](extensions/index.html)
+* [Use Cases](usecases.html)
+* [High Level Design](HighLevelDesign.html)
+* [API](API.html)
+* [Extensions](extensions.html)
---
@@ -27,10 +27,10 @@ powerful environment model and a flexible SPI.
Using Apache Tamaya is simple:
-1. Add `org.apache.tamaya:tamaya-core:${{project.version}}` to your dependencies.
+1. Add `org.apache.tamaya:tamaya-core:{tamaya-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!
+4. Look at the [extension modules](extensions.html) to customize your setup!
5. Enjoy!
@@ -41,9 +41,7 @@ writing similar code again and again in each of our projects. Sometimes in a sim
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...
+Your code is decoupled from the configuratoin backend. There is no difference if your code is deployed on your dev box
+or in a clustered Docker environment in production, it stays the same!
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index aab4821..d01c133 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -40,8 +40,8 @@ under the License.
<menu name="Documentation">
<item name="Quickstart" href="quickstart.html"/>
- <item name="User Guide" href="userguide/index.html"/>
- <item name="Extension Guide" href="extensions/index.html"/>
+ <item name="User Guide" href="userguide.html"/>
+ <item name="Extension Guide" href="extensions.html"/>
<item name="${project.version} JavaDoc" target="" href="apidocs/index.html"/>
</menu>
@@ -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/index.html"/>
+ <item name="Development Guide" href="devguide.html"/>
<item name="Release Guide" href="release-guide.html"/>
</menu>