Repository: incubator-tamaya-site Updated Branches: refs/heads/master c12761dfe -> 3147ee23c
TAMAYA-209: Add skeleton page if javadoc is missing * LHF: Fix broken link in api page 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/3147ee23 Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/3147ee23 Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/3147ee23 Branch: refs/heads/master Commit: 3147ee23c5d07088a553615b3504b7f4864b9eaa Parents: c12761d Author: Phil Ottlinger <[email protected]> Authored: Mon Dec 19 23:07:06 2016 +0100 Committer: Phil Ottlinger <[email protected]> Committed: Mon Dec 19 23:07:06 2016 +0100 ---------------------------------------------------------------------- content/apidocs/index.md | 11 +++++++++++ content/documentation/api.adoc | 5 +++-- 2 files changed, 14 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/3147ee23/content/apidocs/index.md ---------------------------------------------------------------------- diff --git a/content/apidocs/index.md b/content/apidocs/index.md new file mode 100644 index 0000000..18c4948 --- /dev/null +++ b/content/apidocs/index.md @@ -0,0 +1,11 @@ +title=API is missing +type=page +status=published +~~~~~~ + +API is missing +-------------- + +In case you do see this page someone forgot to generate/create the real API/Javadoc by running mvn site:site and copying this over to an apidocs subfolder inside of the asf-site branch. + +Come back later :-) http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/3147ee23/content/documentation/api.adoc ---------------------------------------------------------------------- diff --git a/content/documentation/api.adoc b/content/documentation/api.adoc index 56394a6..a2f4fea 100644 --- a/content/documentation/api.adoc +++ b/content/documentation/api.adoc @@ -6,11 +6,11 @@ Though Tamaya is a very powerful and flexible solution there are basically only a few simple core concepts required that are the base of all the other mechanisms. As a starting point we recommend you read the corresponding -llink:highleveldesign.html[High Level Design Documentation] +link:../highleveldesign.html[High Level Design Documentation] [[API]] == The Tamaya API -The API provides the artifacts as described in the link:highleveldesign.html[High Level Design Documentation], which are: +The API provides the artifacts as described in the link:../highleveldesign.html[High Level Design Documentation], which are: * A simple but complete SE *API* for accessing key/value based _Configuration_: ** +Configuration+ hereby models configuration, the main interface of Tamaya. +Configuration+ provides @@ -116,6 +116,7 @@ Nevertheless most of these advantages can be mitigated easily, hereby still keep [[API Configuration]] + === Configuration +Configuration+ is the main API provided by Tamaya. It allows reading of single property values or the whole
