Author: mduerig
Date: Mon Jul 20 07:58:29 2015
New Revision: 1691883
URL: http://svn.apache.org/r1691883
Log:
OAK-301: Document Oak
Link to http://www.javadoc.io/ for Javadoc of older releases
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md
jackrabbit/oak/trunk/oak-doc/src/site/site.xml
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md?rev=1691883&r1=1691882&r2=1691883&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md
(original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md Mon Jul
20 07:58:29 2015
@@ -18,29 +18,47 @@
Oak API
--------------------------------------------------------------------------------
-_todo_
+- Javadocs (latest release)
+- Javadoc of previous releases are available from
[javadoc.io](http://www.javadoc.io/):
+ - [oak-jcr](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-jcr/)
+ - [oak-core](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-core/)
+ - [oak-run](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-run/)
+ -
[oak-upgrade](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-upgrade/)
+ -
[oak-commons](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-commons/)
+ - [oak-blob](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-blob/)
+ -
[oak-blob-cloud](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-blob-cloud/)
+ - [oak-http](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-http/)
+ - [oak-lucene](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-lucene/)
+ -
[oak-solr-core](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-solr-core/)
+ -
[oak-solr-osgi](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-solr-osgi/)
+ -
[oak-auth-external](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-auth-external/)
+ -
[oak-auth-ldap](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-auth-ldap/)
+ -
[oak-tarmk-standby](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-tarmk-standby/)
+ -
[oak-authorization-cug](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-authorization-cug/)
+ - [oak-remote](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-remote/)
+ -
[oak-exercise](http://www.javadoc.io/doc/org.apache.jackrabbit/oak-exercise/)
+
+### Key API entry points
- [ContentRepository]
- [ContentSession]
- [Root]
- [Tree]
+- [NodeState]
- [PropertyState]
#### Values
-
- [PropertyValue]
- [Type]
- [Blob]
#### Query
-
- [QueryEngine]
- [Query]
- [ResultRow]
#### Various
-
-- [AuthInfo] : see section
[Authentication](../security/authentication/overview.html)
+- [AuthInfo] : see section [Authentication](../security/authentication.html)
- [Descriptors]
- [CommitFailedException] : see also [Error Codes](error_codes.html)
@@ -51,11 +69,13 @@ _todo_
[Root]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Root.html
[Tree]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Tree.html
[PropertyState]:
/oak/docs/apidocs/org/apache/jackrabbit/oak/api/PropertyState.html
+[NodeState]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/NodeState.html
[PropertyValue]:
/oak/docs/apidocs/org/apache/jackrabbit/oak/api/PropertyValue.html
[Type]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Type.html
[Blob]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Blob.html
[QueryEngine]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/QueryEngine.html
[Query]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Query.html
[ResultRow]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/ResultRow.html
+[AuthInfo]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/AuthInfo.html
[Descriptors]: /oak/docs/apidocs/org/apache/jackrabbit/oak/api/Descriptors.html
[CommitFailedException]:
/oak/docs/apidocs/org/apache/jackrabbit/oak/api/CommitFailedException.html
Modified: jackrabbit/oak/trunk/oak-doc/src/site/site.xml
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/site.xml?rev=1691883&r1=1691882&r2=1691883&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Mon Jul 20 07:58:29 2015
@@ -63,7 +63,6 @@ under the License.
<menu name="Developing Oak">
<item href="dev_getting_started.html" name="Getting Started" />
<item href="participating.html" name="Participating" />
- <item href="apidocs/index.html" name="API Docs" />
<item href="attribution.html" name="Attribution" />
</menu>
<menu name="Links">
