tamaya-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anat...@apache.org
Subject [4/4] incubator-tamaya git commit: TAMAYA-80: Added docs module to build chain. Fixed docs build. Updated possible contributions file.
Date Thu, 25 Jun 2015 21:53:33 GMT
TAMAYA-80: Added docs module to build chain. Fixed docs build.
Updated possible contributions file.


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

Branch: refs/heads/master
Commit: 49f97f28179966c31ee8dca7f01a1a41639376b4
Parents: 8b11350
Author: anatole <atsticks@gmail.com>
Authored: Thu Jun 25 23:52:59 2015 +0200
Committer: anatole <atsticks@gmail.com>
Committed: Thu Jun 25 23:52:59 2015 +0200

----------------------------------------------------------------------
 .../asciidoc/misc/PossibleContributions.adoc    | 79 +----------------
 docs/src/main/asciidoc/misc/examples.adoc       | 76 ----------------
 .../main/asciidoc/misc/examples.adoc.nonfunc    | 91 ++++++++++++++++++++
 pom.xml                                         |  1 +
 4 files changed, 96 insertions(+), 151 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/49f97f28/docs/src/main/asciidoc/misc/PossibleContributions.adoc
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/misc/PossibleContributions.adoc b/docs/src/main/asciidoc/misc/PossibleContributions.adoc
index a0040d6..66560ed 100644
--- a/docs/src/main/asciidoc/misc/PossibleContributions.adoc
+++ b/docs/src/main/asciidoc/misc/PossibleContributions.adoc
@@ -63,35 +63,6 @@ which then can be extended or adapted for use in different runtime scenarios,
su
 and more. Similarly additional modules may be provided that help also existing solution to
be plugged into
 {name}, so you can start right away using {name} without having to rebuild/change your existing
application.
 
-== Main Features of {name}
-
-The main features of {name} currently are
-
-* *A simple key/value store*, named +PropertyProvider+ (simply called "provider").
-* Simple *built-in meta-data model*, that allows to easily attach metadata to a provider
or single property keys.
-* Support for *different configuration formats*.
-* Support for *different configuration locations*, including remote locations.
-* Powerful and flexible *options to combine providers to new composite providers* using different
combination policies.
-* The *Configuration model* adds additional features:
-** *Type Adapters* allow to convert configuration into any required target type.
-** *Built-in support* for all basic Java types.
-* *Contextual, hierarchical and multi-layered environment model*. The model is rather simple,
but nevertheless
-  powerful enough to map complex layered runtime environments such as Java EE or multi-tenant
SaaS solutions.
-* *Configurable System Properties* allow to tweak system properties to behave contextually.
-* *Templates* provide a type safe configuration mechanism where an annotated interface is
implemented by the
-  configuration system, providing data from an underlying configuration.
-* *Configuration Injection* allows configured values to be directly injected into the bean's
configured.
-* *Loading Policies* allow to control how configuration changes are reflected on the configured
beans.
-* *Configuration Operators and Queries* can be used to easily implement advanced features
such as *Views,
-  Security Constraints and Filters*.
-* Provider and configuration changes can be observed by registering *PropertyChangeListeners*.
-* Configurations are *versioned*, so remote pull scenarios can be implemented very efficiently.
-* The system supports *multiple configurations* identified by name.
-* The configuration system provides a powerful management console for reading and updating
of configuration.
-* The system also supports distributed configuration scenarios by leveraging existing solutions,
such as Memcached,
-  Hazelcast or Zookeper.
-* The system is built on "Java 8 features*.
-* A *Java 7 Backport* is provided.
 
 === Purpose of this Document
 
@@ -99,28 +70,6 @@ The document should help to organize people and ideas around the Apache
Tamaya L
 ideas and tasks that need to be done. Everybody can have a look at and see, where hos contribution
and capabilities
 would fit best.
 
-== Basics
-
-=== Styles, Logo
-
-The project requires
-
-* a good Apache styled logo and
-* CSS styles as needed,
-* an initial web page,
-* a twitter account
-* ...
-
-=== Infrastructure
-
-We should setup all needed infrastructure
-* code repos
-* project modules (including module sites)
-* coding and documentation guidelines
-* automatic builds (CI), included automatic coverage and sonar quality checks.
-* a docker image or appliance, with everything setup, so contributors can easily
-  start contributing...
-* ...
 
 == Main Features
 
@@ -216,11 +165,6 @@ myTypedMap=[CHF:CHF 10.20, EUR:EUR 12.20, BTC:BTC 0.002]
 ----------------------------------------------------------------
 
 
-=== Management Service
-
-A JMX/Restful API should be designed and built that exposes configuration information. Access
should be secured, e.g.
-using OAuth or other security mechasnisms.
-
 === Management Client
 
 A nice web-based client to manage configuration data would be nice as well. This also includes
a UI for creating new
@@ -235,6 +179,7 @@ storing/retreiving/managing configuration:
 * MongoDB
 * ...
 
+
 === Integration with OSGI
 
 Examples are to be created and tested, where OSGI is used as the basic runtime platform,
e.g. Apache Felix, but as well
@@ -253,20 +198,12 @@ A configuration server should be implemented that provides access to
configurati
 clients (push). Similarly a poull model should be supported, where clients can asl for the
current version id of a certain
 configuration and reload it if necessary.
 
+
 === Configuration Distribution Policies
 
 Different configuration distribution policies should be defined any implemented, e.g. distributed
cache, restful services,
 web services, EJB/RMI calls, asynchronous queues, publish/subsribe models, ...
 
-=== Dynamic Service Lookup
-
-Configuration Servers and Clients should bea ble to locate each other in different ways:
-
-* with fixed configured IPs, or IP ranges
-* using a dynamic service location protocol like
-** SLP
-** Distributed Maps/Datagrids
-** Apache Zookeeper
 
 === Configuration Client
 
@@ -274,10 +211,12 @@ A subset of the API would be created that exposes only a well defined
subset, of
 to a certain instance, VM or whatever. The client should be connectable to a server in different
ways (see configuration
 distributiont policies).
 
+
 === Preferences Support
 
 Write a +PreferencesFactory+ for +java.util.preferences+.
 
+
 == Third Party Integration
 
 === Integration with Deltaspike Config
@@ -313,16 +252,6 @@ deployments based on the configuration service, server to be considered
maybe
 * Glassfish
 * Apache Geronimo
 
-==== Configuration of CDI
-
-Implement a CDI extension that controls CDI based on configuration:
-* Add beans
-* Remove (veto) beans
-* Add/remove interceptors
-* Add/remove decorators
-* Activate alternatives
-* ...
-
 ==== Configuration of Bean Validation
 
 * Add configurable validators.

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/49f97f28/docs/src/main/asciidoc/misc/examples.adoc
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/misc/examples.adoc b/docs/src/main/asciidoc/misc/examples.adoc
deleted file mode 100644
index 55ed049..0000000
--- a/docs/src/main/asciidoc/misc/examples.adoc
+++ /dev/null
@@ -1,76 +0,0 @@
-= Tamayas Asciidoctor Example Document
-Oliver B. Fischer
-
-:encoding: UTF-8
-:source-highlighter: coderay
-
-This document is used to see if the current setup
-of Asciidoctor within the Tamaya project is working
-correctly. Therefore it contains some sections
-with different examples of Asciidoctors capabilities.
-
-== Asciidoctor Environment
-
-Some facts on the current Asciidoctor environment.
-
-Asciidoctor version:: {asciidoctor-version}
-
-
-== Plant UML
-
-This chapter contains a
-http://plantuml.sourceforge.net/[Plant UML] diagram.
-
-
-[plantuml, diagram-classes, png]
-....
-class BlockProcessor
-class DiagramBlock
-class DitaaBlock
-class PlantUmlBlock
-
-BlockProcessor <|-- DiagramBlock
-DiagramBlock <|-- DitaaBlock
-DiagramBlock <|-- PlantUmlBlock
-....
-
-
-== Ditaa
-
-This section contains a diagram from
-http://asciidoctor.org/docs/asciidoctor-diagram/[Asciidoctor Diagram website]
-generated with http://ditaa.sourceforge.net/[ditaa].
-
-[ditaa, "asciidoctor-diagram-process"]
-....
-                   +-------------+
-                   | Asciidoctor |-------+
-                   |   diagram   |       |
-                   +-------------+       | PNG out
-                       ^                 |
-                       | ditaa in        |
-                       |                 v
- +--------+   +--------+----+    /---------------\
- |        |---+ Asciidoctor +--->|               |
- |  Text  |   +-------------+    |   Beautiful   |
- |Document|   |   !magic!   |    |    Output     |
- |     {d}|   |             |    |               |
- +---+----+   +-------------+    \---------------/
-     :                                   ^
-     |          Lots of work             |
-     +-----------------------------------+
-....
-
-
-
-== GraphViz
-
-This section contains a diagram
-[graphviz]
-....
-graph {
-    a -- b; b -- c; c -- d; d -- e; e -- f; a -- f; a -- c[color=red];
-    a -- d; a -- e; b -- d; b -- e; b -- f; c -- e; c -- f;
-    d -- f;
-}
-....

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/49f97f28/docs/src/main/asciidoc/misc/examples.adoc.nonfunc
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/misc/examples.adoc.nonfunc b/docs/src/main/asciidoc/misc/examples.adoc.nonfunc
new file mode 100644
index 0000000..0fca744
--- /dev/null
+++ b/docs/src/main/asciidoc/misc/examples.adoc.nonfunc
@@ -0,0 +1,91 @@
+= Tamayas Asciidoctor Example Document
+Oliver B. Fischer
+// 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.
+:encoding: UTF-8
+:source-highlighter: coderay
+
+This document is used to see if the current setup
+of Asciidoctor within the Tamaya project is working
+correctly. Therefore it contains some sections
+with different examples of Asciidoctors capabilities.
+
+== Asciidoctor Environment
+
+Some facts on the current Asciidoctor environment.
+
+Asciidoctor version:: {asciidoctor-version}
+
+
+== Plant UML
+
+This chapter contains a
+http://plantuml.sourceforge.net/[Plant UML] diagram.
+
+
+[plantuml, diagram-classes, png]
+....
+class BlockProcessor
+class DiagramBlock
+class DitaaBlock
+class PlantUmlBlock
+
+BlockProcessor <|-- DiagramBlock
+DiagramBlock <|-- DitaaBlock
+DiagramBlock <|-- PlantUmlBlock
+....
+
+
+== Ditaa
+
+This section contains a diagram from
+http://asciidoctor.org/docs/asciidoctor-diagram/[Asciidoctor Diagram website]
+generated with http://ditaa.sourceforge.net/[ditaa].
+
+[ditaa, "asciidoctor-diagram-process"]
+....
+                   +-------------+
+                   | Asciidoctor |-------+
+                   |   diagram   |       |
+                   +-------------+       | PNG out
+                       ^                 |
+                       | ditaa in        |
+                       |                 v
+ +--------+   +--------+----+    /---------------\
+ |        |---+ Asciidoctor +--->|               |
+ |  Text  |   +-------------+    |   Beautiful   |
+ |Document|   |   !magic!   |    |    Output     |
+ |     {d}|   |             |    |               |
+ +---+----+   +-------------+    \---------------/
+     :                                   ^
+     |          Lots of work             |
+     +-----------------------------------+
+....
+
+
+
+== GraphViz
+
+This section contains a diagram
+[graphviz]
+....
+graph {
+    a -- b; b -- c; c -- d; d -- e; e -- f; a -- f; a -- c[color=red];
+    a -- d; a -- e; b -- d; b -- e; b -- f; c -- e; c -- f;
+    d -- f;
+}
+....

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/49f97f28/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index bec9b97..b1662eb 100644
--- a/pom.xml
+++ b/pom.xml
@@ -214,6 +214,7 @@ under the License.
         <module>java7</module>
         <module>java8</module>
         <module>modules</module>
+        <module>docs</module>
         <module>distribution</module>
     </modules>
 


Mime
View raw message