tamaya-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anat...@apache.org
Subject [2/3] incubator-tamaya-site git commit: Unified introduction structure. Small fixes and updates.
Date Thu, 26 Jan 2017 11:32:30 GMT
Unified introduction structure.
Small fixes and updates.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/45cc7791
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/45cc7791
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/45cc7791

Branch: refs/heads/master
Commit: 45cc77914f3511cce8736940b0752d8226319edc
Parents: db487e2
Author: anatole <anatole@apache.org>
Authored: Tue Jan 24 21:23:02 2017 +0100
Committer: anatole <anatole@apache.org>
Committed: Tue Jan 24 21:23:02 2017 +0100

----------------------------------------------------------------------
 .../documentation/extensions/mod_builder.adoc   |  7 ++--
 content/documentation/extensions/mod_camel.adoc |  9 ++++--
 content/documentation/extensions/mod_cdi.adoc   |  7 ++--
 .../extensions/mod_classloader_support.adoc     |  9 ++++--
 .../extensions/mod_collections.adoc             |  9 ++++--
 .../documentation/extensions/mod_consul.adoc    |  9 ++++--
 .../extensions/mod_environment.adoc             |  9 ++++--
 content/documentation/extensions/mod_etcd.adoc  |  8 +++--
 .../documentation/extensions/mod_events.adoc    | 34 +++++++++-----------
 .../documentation/extensions/mod_filter.adoc    | 10 ++++--
 .../documentation/extensions/mod_formats.adoc   | 10 +++---
 .../documentation/extensions/mod_functions.adoc | 10 +++---
 .../documentation/extensions/mod_injection.adoc | 10 +++---
 .../documentation/extensions/mod_jodatime.adoc  | 10 +++---
 content/documentation/extensions/mod_json.adoc  |  7 ++--
 .../extensions/mod_management.adoc              |  6 ++--
 .../extensions/mod_metamodel-staged.adoc        |  5 ++-
 content/documentation/extensions/mod_model.adoc |  9 ++++--
 .../extensions/mod_mutable_config.adoc          |  9 ++++--
 .../documentation/extensions/mod_optional.adoc  | 11 ++++---
 content/documentation/extensions/mod_osgi.adoc  | 24 +++++++++-----
 .../documentation/extensions/mod_remote.adoc    |  9 +++---
 .../documentation/extensions/mod_resolver.adoc  |  8 +++--
 .../documentation/extensions/mod_resources.adoc | 12 +++----
 .../documentation/extensions/mod_server.adoc    | 12 +++----
 .../extensions/mod_spi-support.adoc             |  7 ++--
 .../documentation/extensions/mod_spring.adoc    |  9 ++++--
 .../extensions/mod_usagetracker.adoc            |  9 ++++--
 .../extensions/mod_validation.adoc              |  7 ++--
 content/documentation/extensions/mod_yaml.adoc  |  7 ++--
 30 files changed, 183 insertions(+), 119 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_builder.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_builder.adoc b/content/documentation/extensions/mod_builder.adoc
index a589374..9766870 100644
--- a/content/documentation/extensions/mod_builder.adoc
+++ b/content/documentation/extensions/mod_builder.adoc
@@ -5,9 +5,12 @@
 
 [[BuilderCore]]
 == Tamaya Builder (Extension Module)
-=== Overview
 
-The Tamaya builder module provides a generic (one time) builder for creating +Configuration+
instances,
+Tamaya _Builder_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
+=== What functionality this module provides ?
+
+Tamaya _Builder_ provides a generic (one time) builder for creating +Configuration+ instances,
 e.g. as follows:
 
 [source,java]

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_camel.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_camel.adoc b/content/documentation/extensions/mod_camel.adoc
index 9690dda..9255430 100644
--- a/content/documentation/extensions/mod_camel.adoc
+++ b/content/documentation/extensions/mod_camel.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[Optional]]
+[[Camel]]
 == Integration with Apache Camel (Extension Module)
-=== Overview
 
-The Tamaya Camel integration module provides different artifacts which allows integration
of Apachae Tamaya
+Tamaya _Camel_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+=== What functionality this module provides ?
+
+The Tamaya _Camel_ integration module provides different artifacts which allows integration
of Apachae Tamaya
 configuration with Apache Camel.
 
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_cdi.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_cdi.adoc b/content/documentation/extensions/mod_cdi.adoc
index c49a61c..ac9553f 100644
--- a/content/documentation/extensions/mod_cdi.adoc
+++ b/content/documentation/extensions/mod_cdi.adoc
@@ -6,9 +6,12 @@
 toc::[]
 
 
-[[Remote]]
+[[CDI]]
 == Tamaya CDI Integration (Extension Modules)
-=== Overview
+
+Tamaya _CDI_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+=== What functionality this module provides ?
 
 Apache Tamaya currently provides two implementations for integration with CDI extensions
implementing similar
 functionality as described in this document:

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_classloader_support.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_classloader_support.adoc b/content/documentation/extensions/mod_classloader_support.adoc
index 9a2d0df..c254405 100644
--- a/content/documentation/extensions/mod_classloader_support.adoc
+++ b/content/documentation/extensions/mod_classloader_support.adoc
@@ -5,11 +5,14 @@
 
 toc::[]
 
-[[Remote]]
+[[Classloader]]
 == Tamaya Classloader Aware ServiceContext (Extension Module)
-=== Overview
 
-The Tamaya classloader support provides an alternative implementation of +java.util.ServiceLoader+,
which is aware
+Tamaya _Classloader_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
+=== What functionality this module provides ?
+
+The Tamaya _Classloader_ support provides an alternative implementation of +java.util.ServiceLoader+,
which is aware
 of classloaders, hereby preventing multiple loading of components within a classloader hierarchy.
 
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_collections.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_collections.adoc b/content/documentation/extensions/mod_collections.adoc
index e758756..5360bab 100644
--- a/content/documentation/extensions/mod_collections.adoc
+++ b/content/documentation/extensions/mod_collections.adoc
@@ -5,9 +5,12 @@
 
 toc::[]
 
-[[Optional]]
-== Tamaya Collection Support (Extension Module)
-=== Overview
+[[Collections]]
+== Tamaya Collections Support (Extension Module)
+
+Tamaya _Collections_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
+=== What functionality this module provides ?
 
 All configuration in Tamaya is expressed as simple key, value pairs. Nevertheless this concept
allows similarly
 the modelling of collection typed values such as lists, sets, maps or simple collections
of things. The Tamaya

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_consul.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_consul.adoc b/content/documentation/extensions/mod_consul.adoc
index 4407ed3..0463124 100644
--- a/content/documentation/extensions/mod_consul.adoc
+++ b/content/documentation/extensions/mod_consul.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[Optional]]
+[[Consul]]
 == Integration with consul (Extension Module)
-=== Overview
 
-The Tamaya consul integration module provides different artifacts which allows integration
of Apachae Tamaya
+Tamaya _Consul_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+=== What functionality this module provides ?
+
+Tamaya _Consul_ provides different artifacts which allows integration of Apachae Tamaya
 configuration with consul. Basically the module supports read-only integration (as a +ConsulPropertySource+
as well
 as a support for +MutableConfiguration+ as defined by the +tamaya-mutable-config+ extension
module.
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_environment.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_environment.adoc b/content/documentation/extensions/mod_environment.adoc
index c0224a1..01cc49e 100644
--- a/content/documentation/extensions/mod_environment.adoc
+++ b/content/documentation/extensions/mod_environment.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[Remote]]
+[[Environment]]
 == Tamaya Environment Model (Extension Module)
-=== Overview
 
-The Tamaya Environment extension adds a simple PropertySourceProvider that evaluates a List
of environment context and
+Tamaya _Environment_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
+=== What functionality this module provides ?
+
+The Tamaya _Environment_ extension adds a simple PropertySourceProvider that evaluates a
List of environment context and
 combines them in the given order into an (optional) root context within the system's configuration.
 
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_etcd.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_etcd.adoc b/content/documentation/extensions/mod_etcd.adoc
index 149d843..ee77177 100644
--- a/content/documentation/extensions/mod_etcd.adoc
+++ b/content/documentation/extensions/mod_etcd.adoc
@@ -6,11 +6,13 @@
 toc::[]
 
 
-[[Optional]]
+[[Etcd]]
 == Integration with etcd (Extension Module)
-=== Overview
+Tamaya _Etcd_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
 
-The Tamaya etcd integration module provides different artifacts which allows integration
of Apachae Tamaya
+=== What functionality this module provides ?
+
+Tamaya _Etcd_ provides different artifacts which allows integration of Apachae Tamaya
 configuration with etcd. Basically the module supports read-only integration (as a +EtcdPropertySource+
as well
 as a support for +MutableConfiguration+ as defined by the +tamaya-mutable-config+ extension
module.
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_events.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_events.adoc b/content/documentation/extensions/mod_events.adoc
index 512be62..880d80d 100644
--- a/content/documentation/extensions/mod_events.adoc
+++ b/content/documentation/extensions/mod_events.adoc
@@ -6,14 +6,24 @@
 toc::[]
 
 
-[[Core]]
+[[Events]]
 == Tamaya Events (Extension Module)
-=== Overview
 
-Tamaya Events is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details
-about modules.
+Tamaya _Events_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
 
-Tamaya Events provides an abstraction for events like change events, when configuration has
been changed.
+=== What functionality this module provides ?
+
+Tamaya _Events_ provides a mechanism to publish and subscribe to +ConfigEvent<T>+ instances.
+This module implements +ConfigChange+ or +PropertySourceChange+ as possible payloads, but
+the module itself is not constraint to this payload types.
+These payload types describe detected changes of key/values of a +Configuration+ or a +PropertySource+.
+The extension also provides a _Singleton accessor_ which allows to register/unregister
+listeners for changes and the period, when configuration should be scanned for
+any changes.
+
+Summarizing with the events module you can easily observe configuration changes, record the
+state of any configuration and compare configuration states to create and publish related
+change events.
 
 === Compatibility
 
@@ -32,20 +42,6 @@ To benefit from configuration event support you only must add the corresponding
 </dependency>
 -----------------------------------------------
 
-=== What does this module do?
-
-The Tamaya _events_-extension provides a mechanism to publish and subscribe to +ConfigEvent<T>+
instances.
-This module implements +ConfigChange+ or +PropertySourceChange+ as possible payloads, but
-the module itself is not constraint to this payload types.
-These payload types describe detected changes of key/values of a +Configuration+ or a +PropertySource+.
-The extension also provides a _Singleton accessor_ which allows to register/unregister
-listeners for changes and the period, when configuration should be scanned for
-any changes.
-
-Summarizing with the events module you can easily observe configuration changes, record the
-state of any configuration and compare configuration states to create and publish related
-change events.
-
 
 === Core Architecture
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_filter.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_filter.adoc b/content/documentation/extensions/mod_filter.adoc
index 670faa0..581f33d 100644
--- a/content/documentation/extensions/mod_filter.adoc
+++ b/content/documentation/extensions/mod_filter.adoc
@@ -6,11 +6,15 @@
 toc::[]
 
 
-[[Optional]]
+[[Filter]]
 == User Filtering (Extension Module)
-=== Overview
 
-The Tamaya filter module provides a simple singleton accessor that allows to explicitly add
+PropertyFilter+ instances
+Tamaya _Filter_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+
+=== What functionality this module provides ?
+
+Tamaya _Filter_ provides a simple singleton accessor that allows to explicitly add +PropertyFilter+
instances
 active on the current thread only. This can be very useful in many scenarios. Additionally
this module adds
 standard filters that hide metadata entries when the full configuration map is accessed.
When keys are accessed
 explicitily no filtering is applied and everything is visible.

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_formats.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_formats.adoc b/content/documentation/extensions/mod_formats.adoc
index 0ab72fb..f87b720 100644
--- a/content/documentation/extensions/mod_formats.adoc
+++ b/content/documentation/extensions/mod_formats.adoc
@@ -6,13 +6,15 @@
 toc::[]
 
 
-[[Core]]
+[[Formats]]
 == Tamaya Formats (Extension Module)
-=== Overview
 
-Tamaya Formats is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+Tamaya _Formats_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
 
-Tamaya Formats provides an abstraction for configuration formats provding the following benefits:
+
+=== What functionality this module provides ?
+
+Tamaya _Formats_ provides an abstraction for configuration formats provding the following
benefits:
 
 * Parsing of resources in can be implemented separately from interpreting the different aspects/parts
parsed. As an
   example a file format can define different sections. Depending on the company specific
semantics of the sections

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_functions.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_functions.adoc b/content/documentation/extensions/mod_functions.adoc
index 6ec0f54..cf39feb 100644
--- a/content/documentation/extensions/mod_functions.adoc
+++ b/content/documentation/extensions/mod_functions.adoc
@@ -5,13 +5,15 @@
 
 toc::[]
 
-[[Core]]
+[[Functions]]
 == Tamaya Functions (Extension Module)
-=== Overview
 
-Tamaya Functions is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+Tamaya _Functions_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
 
-Tamaya Functions provides several functional extensions using the +ConfigOperator,ConfigQuery+
extension points. Most
+
+=== What functionality this module provides ?
+
+Tamaya _Functions_ provides several functional extensions using the +ConfigOperator,ConfigQuery+
extension points. Most
 functional extension are accessible from the +ConfigurationFunction+ singleton. When importing
its methods statically
 one can use the methods to achieve some interesting effects, e.g.
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_injection.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_injection.adoc b/content/documentation/extensions/mod_injection.adoc
index 0ffde92..2699065 100644
--- a/content/documentation/extensions/mod_injection.adoc
+++ b/content/documentation/extensions/mod_injection.adoc
@@ -6,14 +6,14 @@
 toc::[]
 
 
-[[Core]]
+[[Injection]]
 == Tamaya Injection (Extension Module)
-=== Overview
 
-Tamaya Injection is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details
-about modules.
+Tamaya _Injection_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
 
-Tamaya Injection provides functionality for injecting configured values into beans, or creating
configuration
+=== What functionality this module provides ?
+
+Tamaya _Injection_ provides functionality for injecting configured values into beans, or
creating configuration
 template instances.
 
 Inversion of Control (aka IoC/the Hollywood Principle) has proven to be very useful and effective
in avoiding boilerplate

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_jodatime.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_jodatime.adoc b/content/documentation/extensions/mod_jodatime.adoc
index dc1e94f..f384157 100644
--- a/content/documentation/extensions/mod_jodatime.adoc
+++ b/content/documentation/extensions/mod_jodatime.adoc
@@ -5,18 +5,16 @@
 
 toc::[]
 
-[[Core]]
+[[JodaTime]]
 == Tamaya JodaTime (Extension Module)
+Tamaya _JodaTime_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
 
-=== Overview
+=== What functionality this module provides ?
 
-Tamaya JodaTime is an extension module to support the usage of http://www.joda.org/joda-time/[Joda-Time]
+Tamaya _JodaTime_ is an extension module to support the usage of http://www.joda.org/joda-time/[Joda-Time]
 in conjunction with Tamaya. Tamaya JodaTime defines some additional property
 converters to retrieve Joda-Time types from a given configuration.
 
-Refer to the link:../extensions.html[extensions documentation] for further details
-about modules.
-
 tools to locate resources in your classpath or file system based on descriptive
 ant-styled resource patterns. To use this module add the following dependency:
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_json.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_json.adoc b/content/documentation/extensions/mod_json.adoc
index 66c12fa..c51454e 100644
--- a/content/documentation/extensions/mod_json.adoc
+++ b/content/documentation/extensions/mod_json.adoc
@@ -6,12 +6,13 @@
 toc::[]
 
 
-[[BuilderCore]]
+[[JSON]]
 == Tamaya JSON (Extension Module)
-=== Overview
+Tamaya _JSON_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
 
-The Tamaya json module provides support for reading configuration using JSON format:
+=== What functionality this module provides ?
 
+Tamaya _JSON_ provides support for reading configuration using JSON format:
 
 === Compatibility
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_management.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_management.adoc b/content/documentation/extensions/mod_management.adoc
index b912747..03000e7 100644
--- a/content/documentation/extensions/mod_management.adoc
+++ b/content/documentation/extensions/mod_management.adoc
@@ -8,9 +8,11 @@ toc::[]
 
 [[ExtModel]]
 == Tamaya Management (JMX Support) (Extension Module)
-=== Overview
+Tamaya _Management_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
 
-The Tamaya management module provides support for registering a JMX management bean for accessing
configuration.
+=== What functionality this module provides ?
+
+The Tamaya _Management_ module provides support for registering a JMX management bean for
accessing configuration.
 
 === Compatibility
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_metamodel-staged.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_metamodel-staged.adoc b/content/documentation/extensions/mod_metamodel-staged.adoc
index cf02806..3c8d24c 100644
--- a/content/documentation/extensions/mod_metamodel-staged.adoc
+++ b/content/documentation/extensions/mod_metamodel-staged.adoc
@@ -8,9 +8,12 @@ toc::[]
 
 [[Remote]]
 == Tamaya Metamodel: Staged PropertySources (Extension Module)
+
+Tamaya _Staged_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
 === Overview
 
-The Tamaya Staged PropertySources extension provides a base class and default implementation
for loading
+Tamaya _Staged_ PropertySources extension provides a base class and default implementation
for loading
 multistaged configuration easily from a common configuration location.
 
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_model.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_model.adoc b/content/documentation/extensions/mod_model.adoc
index e454eb1..0f74cfb 100644
--- a/content/documentation/extensions/mod_model.adoc
+++ b/content/documentation/extensions/mod_model.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[ExtModel]]
+[[Model]]
 == Tamaya Model Documentation and Validation (Extension Module)
-=== Overview
 
-The Tamaya model module provides support for documenting configuration and validating configuration
read and processed
+Tamaya _Model_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+=== What functionality this module provides ?
+
+The Tamaya _Model_ module provides support for documenting configuration and validating configuration
read and processed
 against this model. Documentation and config models can be provided in different ways:
 
 * as separate meta-model documents

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_mutable_config.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_mutable_config.adoc b/content/documentation/extensions/mod_mutable_config.adoc
index cb8869d..6e596ca 100644
--- a/content/documentation/extensions/mod_mutable_config.adoc
+++ b/content/documentation/extensions/mod_mutable_config.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[Core]]
+[[MutableConfiguration]]
 == Tamaya Mutable Configuration (Extension Module)
-=== Overview
 
-Tamaya Configuration by default is read-only, which covers must of the use cases. But there
are many legit scenarios
+Tamaya _Mutable Configuration_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
+=== What functionality this module provides ?
+
+Tamaya +Configuration+ by default is read-only, which covers must of the use cases. But there
are many legit scenarios
 where configuration should be written back to some backend systems or the local file system.
This module adds this
 functionality.
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_optional.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_optional.adoc b/content/documentation/extensions/mod_optional.adoc
index 1a4b967..f7fcbbd 100644
--- a/content/documentation/extensions/mod_optional.adoc
+++ b/content/documentation/extensions/mod_optional.adoc
@@ -7,10 +7,13 @@ toc::[]
 
 
 [[Optional]]
-== Tamaya Optional Configuration (Extension Module)
-=== Overview
+== Tamaya Optional (Extension Module)
 
-The Tamaya optional module provides contains three types only. It is for projects that want
to benefit from Tamaya
+Tamaya _Optional_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
+=== What functionality this module provides ?
+
+Tamaya _Optional_ provides contains three types only. It is for projects that want to benefit
from Tamaya
 configuration optionally only. E.g. doing an OSS project you can declare to support configuration
with Tamaya as
 an optional extension. This module can be added as a hard dependency to your code, hereby
adding only three artofacts.
 It automatically checks the availability of Tamaya on the classpath and only if available
tries to access it for
@@ -39,7 +42,7 @@ To benefit from configuration builder support you only must add the correspondin
 
 === Reading configuration using the Tamaya Optional Module
 
-The optional module allows reading configuration with a small subset of functionality only.
For extended of full
+Tamaya _Optional_ allows reading configuration with a small subset of functionality only.
For extended of full
 featured config please consider using the Apache Tamaya as a full configuration backend.
 
 [source, java]

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_osgi.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_osgi.adoc b/content/documentation/extensions/mod_osgi.adoc
index 9a6a55d..910e9fa 100644
--- a/content/documentation/extensions/mod_osgi.adoc
+++ b/content/documentation/extensions/mod_osgi.adoc
@@ -6,15 +6,17 @@
 toc::[]
 
 
-[[Optional]]
+[[OSGI]]
 == Tamaya OSGI Support
-=== Overview
 
-Tamaya provides also support for integration with OSGI. Hereby Tamaya implements the OSGI
+ConfigAdmin+ service,
+Tamaya _OSGI_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+=== What functionality this module provides ?
+
+Tamaya _OSGI_ provides also support for integration with OSGI. Hereby Tamaya implements the
OSGI +ConfigAdmin+ service,
 which is the OSGI basic component providing configuration. Tamaya by default overrides the
OSGI default configuration
 but can also be configured to extend it.
 
-
 === Compatibility
 
 All module described are based on Java 7, so it will run on Java 7 and beyond.
@@ -25,7 +27,6 @@ runtimes:
 * tbd: Apache Felix, version x.x.x.
 * tbd: Eclipse Equinox, version x.x.x.
 
-
 === Installation
 
 To benefit from Tamaya in an OSGI context you must deploy at least the following modules
to your OSGI runtime
@@ -41,7 +42,6 @@ org.apache.tamaya.ext:tamaya-functions:{tamaya_version}
 org.apache.tamaya.ext:tamaya-osgi:{tamaya_version}
 -----------------------------------------------
 
-
 === How Tamaya deals with OSGI Specialities
 
 Important to know is that within OSGI class- and resource loading is not compatible with
standard Java SE. Also bundle can
@@ -107,9 +107,17 @@ public interface OSGIConfigRootMapper {
 -----------------------------------------------
 
 
+=== Special OSGI Platform support
+
+==== Apache Karaf
+
+Apache Tamaya provides a Karaf feature with all required dependencies
+as
+
+
 == Tamaya based Injection
 
-=== Overview
+=== What functionality ir provided ?
 
 OSGI itself already provides injection and configuration mechanism. Since Tamaya is working
in the back
 you can continue to use the mechanism of your choice. Nevertheless Tamaya also supports enabling
Tamaya
@@ -125,7 +133,7 @@ OSGI support described earlier in this document:
 -----------------------------------------------
 org.apache.geronimo.specs:geronimo-atinject_1.0_spec:1.0
 org.apache.tamaya.ext:tamaya-inject-api:{tamaya_version}
-org.apache.tamaya.ext:tamaya-inject-se:{tamaya_version}
+org.apache.tamaya.ext:tamaya-inject:{tamaya_version}
 org.apache.tamaya.ext:tamaya-inject-osgi:{tamaya_version}
 -----------------------------------------------
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_remote.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_remote.adoc b/content/documentation/extensions/mod_remote.adoc
index ce303ed..53e4c49 100644
--- a/content/documentation/extensions/mod_remote.adoc
+++ b/content/documentation/extensions/mod_remote.adoc
@@ -8,18 +8,19 @@ toc::[]
 
 [[Remote]]
 == Tamaya Remote Configuration (Extension Module)
-=== Overview
 
-The Tamaya remote module provides support for reading configuration from remote resources.
It provides
+Tamaya _Remote_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+=== What functionality this module provides ?
+
+Tamaya _Remote_ provides support for reading configuration from remote resources. It provides
 especially out-of-the-box support for reading scoped configuration from a configuration server
as
 provided with the _Tamaya server module_ .
 
-
 === Compatibility
 
 The module is based on Java 7, so it will not run on Java 7 and beyond.
 
-
 === Installation
 
 To benefit from configuration builder support you only must add the corresponding dependency
to your module:

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_resolver.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_resolver.adoc b/content/documentation/extensions/mod_resolver.adoc
index a7f92c5..f66e3b6 100644
--- a/content/documentation/extensions/mod_resolver.adoc
+++ b/content/documentation/extensions/mod_resolver.adoc
@@ -3,12 +3,14 @@
 
 = Apache Tamaya -- Extension: Resolver
 
-[[Core]]
+[[Resolver]]
 == Tamaya Resolver (Extension Module)
 
-=== Overview
+Tamaya _Resolver_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
 
-Tamaya Resolver is an extension module. Refer to the
+=== What functionality this module provides ?
+
+Tamaya _Resolver_ is an extension module. Refer to the
 link:../extensions.html[extensions documentation]
 for further details about modules.
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_resources.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_resources.adoc b/content/documentation/extensions/mod_resources.adoc
index e15b56e..3468246 100644
--- a/content/documentation/extensions/mod_resources.adoc
+++ b/content/documentation/extensions/mod_resources.adoc
@@ -3,15 +3,14 @@
 
 = Apache Tamaya -- Extension: Resources
 
-[[Core]]
+[[Resources]]
 == Tamaya Resources (Extension Module)
-=== Overview
 
-Tamaya Resources is an extension module. Refer to the
-link:../extensions.html[extensions documentation] for further details
-about modules.
+Tamaya _Resources_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
 
-Tamaya Resources defines some additional tools to locate resources in your classpath or file
system based on descriptive
+=== What functionality this module provides ?
+
+Tamaya _Resources_ defines some additional tools to locate resources in your classpath or
file system based on descriptive
 ant-styled resource patterns. To use this module add the following dependency:
 
 [source, listing, subs="verbatim,attributes"]
@@ -23,7 +22,6 @@ ant-styled resource patterns. To use this module add the following dependency:
 </dependency>
 -----------------------------------------------
 
-
 The module's main entry point is the singleton class +org.apache.tamaya.resource.ConfigResources+.
This class
 provides access to a +ResourceResolver+ instance:
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_server.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_server.adoc b/content/documentation/extensions/mod_server.adoc
index 025da45..7f1c8e8 100644
--- a/content/documentation/extensions/mod_server.adoc
+++ b/content/documentation/extensions/mod_server.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[Remote]]
+[[Server]]
 == Tamaya Configuration Server (Extension Module)
-=== Overview
 
-The Tamaya server module provides support for providing scoped configuration using a http
server serving JSON formatted
+Tamaya _Server_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+=== What functionality this module provides ?
+
+The Tamaya _Server_ module provides support for providing scoped configuration using a http
server serving JSON formatted
 configuration properties.
 
 
@@ -18,7 +21,6 @@ configuration properties.
 
 The module is based on Java 7, so it will not run on Java 7 and beyond.
 
-
 === Installation
 
 To benefit from configuration server support you only must add the corresponding dependency
to your module:
@@ -32,7 +34,6 @@ To benefit from configuration server support you only must add the corresponding
 </dependency>
 -----------------------------------------------
 
-
 === Providing configuration using the Tamaya Built-in Configuration Server
 
 THe most simple way for providing onfiguration ist to start the internal server:
@@ -256,7 +257,6 @@ Configuration:
 -----------------------------------------------
 
 === SPI
-
 ==== Scopes
 
 As mentioned earlier in this document scopes can be used to define the exact configuration
tree to be returned, e.g.

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_spi-support.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_spi-support.adoc b/content/documentation/extensions/mod_spi-support.adoc
index 7aca208..105ca84 100644
--- a/content/documentation/extensions/mod_spi-support.adoc
+++ b/content/documentation/extensions/mod_spi-support.adoc
@@ -8,9 +8,12 @@ toc::[]
 
 [[SPISupport]]
 == Tamaya SPI Support (Extension Module)
-=== Overview
 
-The Tamaya SPI support module provides a few helpful base classes that can be used to implement
some of the often
+Tamaya _SPI Support_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
+=== What functionality this module provides ?
+
+Tamaya _SPI Support_ provides a few helpful base classes that can be used to implement some
of the often
 used SPI parts in Tamaya:
 
 * +BasePropertySource+ provides an abstract base class for implementation of your own PropertySources.

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_spring.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_spring.adoc b/content/documentation/extensions/mod_spring.adoc
index 3960dc1..420b49f 100644
--- a/content/documentation/extensions/mod_spring.adoc
+++ b/content/documentation/extensions/mod_spring.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[Remote]]
+[[Spring]]
 == Tamaya Spring Integration (Extension Module)
-=== Overview
 
-Apache Tamaya currently provides two implementations also full integration for Spring:
+Tamaya _Spring_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
+=== What functionality this module provides ?
+
+Tamaya _Spring_ currently provides two implementations also full integration for Spring:
 
 * A Spring +@Configuration+ implementation that also provides a Tamaya based version of
   +org.springframework.context.support.PropertySourcesPlaceholderConfigurer+.

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_usagetracker.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_usagetracker.adoc b/content/documentation/extensions/mod_usagetracker.adoc
index fdb44cc..6a444f6 100644
--- a/content/documentation/extensions/mod_usagetracker.adoc
+++ b/content/documentation/extensions/mod_usagetracker.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[Core]]
+[[UsageTracker]]
 == Tamaya Usage Tracking (Extension Module)
-=== Overview
 
-Tamaya Usage Tracking allows to record and count the configuration access and consumer locations
in your local
+Tamaya _UsageTracker_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
+=== What functionality this module provides ?
+
+Tamaya _UsageTracker_ allows to record and count the configuration access and consumer locations
in your local
 VM.
 
 === Compatibility

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_validation.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_validation.adoc b/content/documentation/extensions/mod_validation.adoc
index ffb033f..8a6c547 100644
--- a/content/documentation/extensions/mod_validation.adoc
+++ b/content/documentation/extensions/mod_validation.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[Remote]]
+[[Validation]]
 == Tamaya Validation: Validating Configuration (Extension Module)
+
+Tamaya _Validation_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
+
 === Overview
 
-The Tamaya Validation extension adds support to validate a configuration against a set of
rules
+Tamaya _Validation_ adds support to validate a configuration against a set of rules
 defined in a Tamaya Metaconfiguration XML file.
 
 === Compatibility

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/45cc7791/content/documentation/extensions/mod_yaml.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_yaml.adoc b/content/documentation/extensions/mod_yaml.adoc
index b7e53cb..82b0f33 100644
--- a/content/documentation/extensions/mod_yaml.adoc
+++ b/content/documentation/extensions/mod_yaml.adoc
@@ -6,11 +6,14 @@
 toc::[]
 
 
-[[BuilderCore]]
+[[YAML]]
 == Tamaya YAML (Extension Module)
+
+Tamaya _YAML_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
+
 === Overview
 
-The Tamaya YAML module provides support for reading configuration using the YAML format (yaml.org).
YAML hereby
+Tamaya _YAML_ provides support for reading configuration using the YAML format (yaml.org).
YAML hereby
 use intendation for expressing hierarchy, which makes yaml configuration files very easily
readable and compact.
 
 



Mime
View raw message