You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by md...@apache.org on 2013/07/26 11:55:20 UTC
svn commit: r1507244 - in /jackrabbit/oak/trunk/oak-doc/src/site: ./
markdown/
Author: mduerig
Date: Fri Jul 26 09:55:20 2013
New Revision: 1507244
URL: http://svn.apache.org/r1507244
Log:
OAK-301: Document Oak
refine todos
Added:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md
Removed:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/resources.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/dev_getting_started.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/dos_and_donts.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/microkernel.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/when_things_go_wrong.md
jackrabbit/oak/trunk/oak-doc/src/site/site.xml
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/dev_getting_started.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/dev_getting_started.md?rev=1507244&r1=1507243&r2=1507244&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/dev_getting_started.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/dev_getting_started.md Fri Jul 26 09:55:20 2013
@@ -77,3 +77,5 @@ The build consists of the following main
- oak-it/osgi - integration tests for OSGi
[1]: https://github.com/apache/jackrabbit-oak/blob/trunk/oak-core/README.md
+
+TODO: Link to additional readmes (benchmark runner, ...)
\ No newline at end of file
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md?rev=1507244&r1=1507243&r2=1507244&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md Fri Jul 26 09:55:20 2013
@@ -15,4 +15,9 @@
limitations under the License.
-->
-TODO
\ No newline at end of file
+TODO Consolidate info from various sources:
+
+* https://issues.apache.org/jira/browse/OAK-14
+* http://wiki.apache.org/jackrabbit/Transactional%20model%20of%20the%20Microkernel%20based%20Jackrabbit%20prototype
+* MVCC side effects regarding session refresh
+* ...
\ 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=1507244&r1=1507243&r2=1507244&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 Fri Jul 26 09:55:20 2013
@@ -15,4 +15,9 @@
limitations under the License.
-->
-TODO
\ No newline at end of file
+TODO Document patterns and anti patterns:
+
+* Observation
+* Session live time, explicit refresh
+* Use admin session
+* ...
\ 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=1507244&r1=1507243&r2=1507244&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md Fri Jul 26 09:55:20 2013
@@ -20,12 +20,9 @@ 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/). Oak is
+currently alpha-level software. Use at your own risk with no stability or compatibility guarantees.
Why Oak
-------
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/microkernel.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/microkernel.md?rev=1507244&r1=1507243&r2=1507244&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/microkernel.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/microkernel.md Fri Jul 26 09:55:20 2013
@@ -15,8 +15,7 @@
limitations under the License.
-->
-TODO
+TODO: Document Microkernel API and implementations
-[SegmentMK design overview](segmentmk.html)
-
-[Oak MongoMK](mongomk.html)
\ No newline at end of file
+* [SegmentMK design overview](segmentmk.html)
+* [Oak MongoMK](mongomk.html)
\ No newline at end of file
Added: 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=1507244&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md (added)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md Fri Jul 26 09:55:20 2013
@@ -0,0 +1,15 @@
+TODO: Document core concepts and architecture:
+
+* MVCC
+* Microkernel
+* JSOP
+* NodeStateDiff
+* NodeStore
+* Tree
+* Plugins
+* APIs (MK, oak-core, oak-jcr)
+* SPIs (...)
+* Clustering
+* Search and indexing
+* Security
+* ...
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md?rev=1507244&r1=1507243&r2=1507244&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md Fri Jul 26 09:55:20 2013
@@ -15,6 +15,8 @@
limitations under the License.
-->
-TODO
+TODO: Document how to use Oak:
-[Repository construction](construct.html)
+* Required (Maven) Dependencies
+* [Repository construction](construct.html)
+* Standalone
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/when_things_go_wrong.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/when_things_go_wrong.md?rev=1507244&r1=1507243&r2=1507244&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/when_things_go_wrong.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/when_things_go_wrong.md Fri Jul 26 09:55:20 2013
@@ -15,4 +15,9 @@
limitations under the License.
-->
-TODO
\ No newline at end of file
+TODO document where to look for additional help:
+
+* Log entries to watch out for
+* Compare with Jackrabbit 2
+* Known issues
+* ...
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=1507244&r1=1507243&r2=1507244&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Fri Jul 26 09:55:20 2013
@@ -30,7 +30,8 @@ under the License.
<item href="downloads.html" name="Downloads" />
<item href="from_here.html" name="From here" />
</menu>
- <menu name="Architecture">
+ <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" />
</menu>
@@ -42,7 +43,6 @@ under the License.
</menu>
<menu name="Developing Oak">
<item href="dev_getting_started.html" name="Getting Started" />
- <item href="resources.html" name="Resources" />
<item href="participating.html" name="Participating" />
<item href="api.html" name="API docs" />
</menu>