jackrabbit-oak-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mdue...@apache.org
Subject svn commit: r1585427 - in /jackrabbit/oak/trunk/oak-doc/src/site: ./ markdown/ markdown/security/ resources/
Date Mon, 07 Apr 2014 08:28:33 GMT
Author: mduerig
Date: Mon Apr  7 08:28:33 2014
New Revision: 1585427

URL: http://svn.apache.org/r1585427
Log:
OAK-301: Document Oak
brushing up a bit

Added:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/big-picture.png
      - copied, changed from r1585305, jackrabbit/oak/trunk/oak-doc/src/site/resources/big-picture.png
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/big-picture.uxf
      - copied, changed from r1585305, jackrabbit/oak/trunk/oak-doc/src/site/resources/big-picture.uxf
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/clustering.md
      - copied, changed from r1585305, jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/overview.md
      - copied, changed from r1585305, jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md
Removed:
    jackrabbit/oak/trunk/oak-doc/src/site/resources/big-picture.png
    jackrabbit/oak/trunk/oak-doc/src/site/resources/big-picture.uxf
Modified:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/dos_and_donts.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/known_issues.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md
    jackrabbit/oak/trunk/oak-doc/src/site/site.xml

Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/big-picture.png (from r1585305, jackrabbit/oak/trunk/oak-doc/src/site/resources/big-picture.png)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/big-picture.png?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/big-picture.png&p1=jackrabbit/oak/trunk/oak-doc/src/site/resources/big-picture.png&r1=1585305&r2=1585427&rev=1585427&view=diff
==============================================================================
Binary files - no diff available.

Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/big-picture.uxf (from r1585305, jackrabbit/oak/trunk/oak-doc/src/site/resources/big-picture.uxf)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/big-picture.uxf?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/big-picture.uxf&p1=jackrabbit/oak/trunk/oak-doc/src/site/resources/big-picture.uxf&r1=1585305&r2=1585427&rev=1585427&view=diff
==============================================================================
    (empty)

Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/clustering.md (from r1585305, jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/clustering.md?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/clustering.md&p1=jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md&r1=1585305&r2=1585427&rev=1585427&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/clustering.md Mon Apr  7 08:28:33 2014
@@ -15,11 +15,4 @@
    limitations under the License.
   -->
 
-Downloads
-=========
-The latest Oak sources are available for checkout from [svn]
-(https://svn.apache.org/repos/asf/jackrabbit/oak/trunk), or you can [fork them]
-(https://github.com/apache/jackrabbit-oak) on GitHub.
-
-See also our [monthly releases](http://jackrabbit.apache.org/downloads.html) on the Jackrabbit
-download page for slightly more stable versions of the codebase.
\ No newline at end of file
+TODO...
\ No newline at end of file

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/dos_and_donts.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/dos_and_donts.md?rev=1585427&r1=1585426&r2=1585427&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/dos_and_donts.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/dos_and_donts.md Mon Apr  7 08:28:33 2014
@@ -17,11 +17,6 @@
 
 TODO Document patterns and anti patterns:
 
-* Observation
-* Session live time, explicit refresh
-* Use admin session
-* ...
-
 ## Session refresh behavior
 
 Oak is based on the MVCC model where each session starts with a snapshot
@@ -42,3 +37,11 @@ session always up to date with latest ch
 One of the key patterns targeted by Oak is a web application that serves
 HTTP requests. The recommended way to handle such cases is to use a
 separate session for each HTTP request, and never to refresh that session.
+
+### Anti pattern: concurrent session access
+
+Oak is designed to be virtually lock free as long as sessions are not shared
+across threads. Don't access the same session instance concurrently from
+multiple threads. When doing so Oak will protect its internal data structures
+from becoming corrupted but will not make any guarantees beyond that. In
+particular violating clients might suffer from lock contentions or deadlocks.

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md?rev=1585427&r1=1585426&r2=1585427&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md Mon Apr  7 08:28:33 2014
@@ -21,5 +21,5 @@ The latest Oak sources are available for
 (https://svn.apache.org/repos/asf/jackrabbit/oak/trunk), or you can [fork them]
 (https://github.com/apache/jackrabbit-oak) on GitHub.
 
-See also our [monthly releases](http://jackrabbit.apache.org/downloads.html) on the Jackrabbit
+See also our [frequent releases](http://jackrabbit.apache.org/downloads.html) on the Jackrabbit
 download page for slightly more stable versions of the codebase.
\ No newline at end of file

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md?rev=1585427&r1=1585426&r2=1585427&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md Mon Apr  7 08:28:33 2014
@@ -21,8 +21,7 @@ Jackrabbit Oak - the next generation con
 Jackrabbit Oak is an effort to implement a scalable and performant hierarchical content repository
 for use as the foundation of modern world-class web sites and other demanding content applications.
 The Oak effort is a part of the [Apache Jackrabbit project](http://jackrabbit.apache.org/).
Apache
-Jackrabbit is a project of the [Apache Software Foundation](http://www.apache.org/). Oak
is
-currently alpha-level software. Use at your own risk with no stability or compatibility guarantees.
+Jackrabbit is a project of the [Apache Software Foundation](http://www.apache.org/).
 
 Why Oak
 -------
@@ -47,7 +46,7 @@ See the Jackrabbit Wiki for an initial l
 
 Work in Progress
 ----------------
-This documentation is very much work in progress. Currently much of the information on Oak
is
+This documentation is still work in progress. Currently much of the information on Oak is
 somewhat spread over different places. If you don't find something here you could also try
 
 * the [Jackrabbit Oak Wiki Page](http://wiki.apache.org/jackrabbit/Jackrabbit%203),

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/known_issues.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/known_issues.md?rev=1585427&r1=1585426&r2=1585427&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/known_issues.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/known_issues.md Mon Apr  7 08:28:33 2014
@@ -21,32 +21,8 @@ All known issues are listed in the Apach
 Changes with respect to Jackrabbit-core are collected in [OAK-14]
 (https://issues.apache.org/jira/browse/OAK-14) and its sub-tasks.
 
-* Locking:
-    * Locking and unlocking of nodes is not implemented yet. You will not see an exception
as long as
-      the [TODO](https://issues.apache.org/jira/browse/OAK-193)-flag prevents the implementation
from
-      throwing UnsupportedOperationException, but the node *will not* be locked.
-      See [OAK-150](https://issues.apache.org/jira/browse/OAK-150)
-
-
-* Versioning [OAK-168](https://issues.apache.org/jira/browse/OAK-168):
-    * `VersionHistory#removeVersion()` is not implemented yet
-    * `VersionManager#merge()` is not implemented yet
-    * `VersionManager#restore()` with version-array is not implemented yet
-    * Activities are not implemented
-    * Configurations are not implemented
-
-
-* Query:
-    * Known issue with OR statements in full text queries
-      See [OAK-902](https://issues.apache.org/jira/browse/OAK-902)
-
-
 * Workspace Operations:
     * Cross workspace operations are not implemented yet
-      See [OAK-916](https://issues.apache.org/jira/browse/OAK-916)
+      See [OAK-118](https://issues.apache.org/jira/browse/OAK-118)
     * Workspace Management (creating/deleting workspaces) is not implemented yet
-      See [OAK-916](https://issues.apache.org/jira/browse/OAK-916)
-
-
-In some cases Oak throws Runtime exceptions instead of a properly typed exception. We are
working
-on correcting this. Please do not work around this by adapting catch clauses in your application.
+      See [OAK-118](https://issues.apache.org/jira/browse/OAK-118)

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md?rev=1585427&r1=1585426&r2=1585427&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md Mon Apr  7 08:28:33 2014
@@ -15,21 +15,14 @@
    limitations under the License.
   -->
 
-TODO: Document core concepts and architecture:
+# The big picture
 
-* MVCC
-* Microkernel
-* JSOP
-* NodeStateDiff
-* NodeStore
-* Tree
-* Plugins
-* APIs (MK, oak-core, oak-jcr)
-* SPIs (...)
-* Clustering
-* Search and indexing
-* Security
-    * [Permission Evaluation](security/permission_eval.html)
-    * [Authentication / Login Modules](security/external_login_module.html)
-* [Oak Core](https://github.com/apache/jackrabbit-oak/blob/trunk/oak-core/README.md)
-* ...
+![The big picture](big-picture.png?raw=true)
+
+TODO: Explain concepts: MVCC, Oak modules and plugins, key APIs, ...
+
+## Readmes
+
+* [Oak](https://github.com/apache/jackrabbit-oak/blob/trunk/README.md)
+* [Oak core](https://github.com/apache/jackrabbit-oak/blob/trunk/oak-core/README.md)
+* [Oak run](https://github.com/apache/jackrabbit-oak/blob/trunk/oak-run/README.md)

Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/overview.md (from r1585305,
jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/overview.md?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/overview.md&p1=jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md&r1=1585305&r2=1585427&rev=1585427&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/security/overview.md Mon Apr  7 08:28:33
2014
@@ -15,11 +15,6 @@
    limitations under the License.
   -->
 
-Downloads
-=========
-The latest Oak sources are available for checkout from [svn]
-(https://svn.apache.org/repos/asf/jackrabbit/oak/trunk), or you can [fork them]
-(https://github.com/apache/jackrabbit-oak) on GitHub.
+# Overview
 
-See also our [monthly releases](http://jackrabbit.apache.org/downloads.html) on the Jackrabbit
-download page for slightly more stable versions of the codebase.
\ No newline at end of file
+* [Authentication / Login Modules](external_login_module.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=1585427&r1=1585426&r2=1585427&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Mon Apr  7 08:28:33 2014
@@ -32,18 +32,20 @@ under the License.
     </menu>
     <menu name="Concepts and architecture">
       <item href="overview.html" name="Overview" />
-      <item href="nodestate.html" name="Understanding the node state model" />
-      <item href="microkernel.html" name="Microkernel" />
+      <item href="nodestate.html" name="The node state model" />
+      <item href="microkernel.html" name="NodesStore and MicroKernel" />
       <item href="query.html" name="Query" />
       <item href="blobstore.html" name="BlobStore" />
+      <item href="security/overview.html" name="Security" />
+      <item href="clustering.html" name="Clustering" />
     </menu>
     <menu name="Using Oak">
       <item href="use_getting_started.html" name="Getting Started" />
       <item href="differences.html" name="Differences to Jackrabbit 2" />
+      <item href="osgi_config.html" name="Configuring Oak" />
       <item href="known_issues.html" name="Known Issues" />
       <item href="dos_and_donts.html" name="Dos and don'ts" />
       <item href="when_things_go_wrong.html" name="When things go wrong" />
-      <item href="osgi_config.html" name="Configuring Oak" />
     </menu>
     <menu name="Developing Oak">
       <item href="dev_getting_started.html" name="Getting Started" />



Mime
View raw message