jackrabbit-oak-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mdue...@apache.org
Subject svn commit: r1506566 - in /jackrabbit/oak/trunk/oak-doc/src/site: ./ markdown/
Date Wed, 24 Jul 2013 14:08:46 GMT
Author: mduerig
Date: Wed Jul 24 14:08:45 2013
New Revision: 1506566

URL: http://svn.apache.org/r1506566
Log:
OAK-301: Document Oak
Adding content (WIP)

Added:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/dev_getting_started.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/participating.md
      - copied, changed from r1506514, jackrabbit/oak/trunk/oak-doc/src/site/markdown/contributing.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md
      - copied, changed from r1506514, jackrabbit/oak/trunk/oak-doc/src/site/markdown/getting_started.md
Removed:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/contributing.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/getting_started.md
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/info.md
Modified:
    jackrabbit/oak/trunk/oak-doc/src/site/markdown/api.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/site.xml

Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/api.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/api.md?rev=1506566&r1=1506565&r2=1506566&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/api.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/api.md Wed Jul 24 14:08:45 2013
@@ -15,4 +15,4 @@
    limitations under the License.
   -->
 
-TODO
\ No newline at end of file
+* TODO: This should link to the current version's API docs
\ No newline at end of file

Added: 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=1506566&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/dev_getting_started.md (added)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/dev_getting_started.md Wed Jul 24 14:08:45
2013
@@ -0,0 +1,79 @@
+<!--
+   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.
+  -->
+
+Getting Started
+---------------
+
+Many parts of Oak are still under construction, so it may be a bit difficult to find your
way around
+the codebase. The [README files](https://github.com/apache/jackrabbit-oak/blob/trunk/README.md),
the
+[Jackrabbit 3 wiki page](http://wiki.apache.org/jackrabbit/Jackrabbit%203), and the
+[Oak mailing list](http://oak.markmail.org/) archives are good places to start learning about
Oak.
+
+To get started developing Oak, build the latest sources with Maven 3 and Java 6 (or higher)
like
+this:
+
+    mvn clean install
+
+To enable all integration tests, including the JCR TCK, use:
+
+    mvn clean install -PintegrationTesting
+
+Before committing changes or submitting a patch, please make sure that the above integration
testing
+build passes without errors. If you like, you can enable integration tests by default by
setting the
+`OAK_INTEGRATION_TESTING` environment variable.
+
+MongoDB integration
+-------------------
+
+Parts of the Oak build expects a MongoDB instance to be available for testing. By default
a MongoDB
+instance running on localhost is expected, and the relevant tests are simply skipped if such
an
+instance is not found. You can also configure the build to use custom MongoDB settings with
the
+following properties (shown with their default values):
+
+    -Dmongo.host=127.0.0.1
+    -Dmongo.port=27017
+    -Dmongo.db=MongoMKDB
+    -Dmongo.db2=MongoMKDB2
+
+Note that the configured test databases will be *dropped* by the test cases.
+
+Components
+----------
+
+The build consists of the following main components:
+
+  - oak-parent        - parent POM
+  - oak-doc           - Oak documentation
+  - oak-commons       - shared utility code
+  - oak-mk-api        - MicroKernel API
+  - oak-mk            - default MicroKernel implementation
+  - oak-mk-remote     - MicroKernel remoting
+  - [oak-core][1]     - Oak repository API and implementation
+  - oak-jcr           - JCR binding for the Oak repository
+  - oak-sling         - integration with Apache Sling
+  - oak-solr-core     - Apache Solr indexing and search
+  - oak-solr-embedded - Apache Solr on an embedded Solr instance
+  - oak-solr-remote   - Apache Solr on an remote (HTTP) Solr instance
+  - oak-http          - HTTP binding for Oak
+  - oak-lucene        - Lucene-based query index
+  - oak-run           - runnable jar packaging
+  - oak-upgrade       - tooling for upgrading Jackrabbit repositories to Oak
+  - oak-it            - integration tests
+    - oak-it/mk       - integration tests for MicroKernel
+    - oak-it/osgi     - integration tests for OSGi
+
+  [1]: https://github.com/apache/jackrabbit-oak/blob/trunk/oak-core/README.md

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=1506566&r1=1506565&r2=1506566&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/downloads.md Wed Jul 24 14:08:45 2013
@@ -15,4 +15,11 @@
    limitations under the License.
   -->
 
-TODO
\ No newline at end of file
+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

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=1506566&r1=1506565&r2=1506566&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md Wed Jul 24 14:08:45 2013
@@ -15,4 +15,36 @@
    limitations under the License.
   -->
 
-TODO
\ No newline at end of file
+Jackrabbit Oak - the next generation content repository
+=======================================================
+
+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.
+
+Why Oak
+-------
+
+Jackrabbit 2.x is a solid and feature-rich content repository that works well especially
for the
+needs of traditional web sites and integrated content management applications. However, the
trends
+in user expectations (especially for personalized, interactive and collaborative content),
+application architectures (distributed, loosely coupled, multi-platform solutions with lots
of data)
+and hardware design (horizontal rather than vertical scaling) have rendered some of the original
+Jackrabbit design decisions (which date back almost a decade) obsolete and there is no easy
way to
+incrementally update the design.
+
+Jackrabbit Oak aims 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
+repository should implement standards like JCR, WebDAV and CMIS, and be easily accessible
from
+various platforms, especially from JavaScript clients running in modern browser environments.
The
+implementation should provide more out-of-the-box functionality than typical NoSQL databases
while
+achieving comparable levels of scalability and performance.
+
+See the Jackrabbit Wiki for an initial list of [goals and non goals]
+(https://wiki.apache.org/jackrabbit/Goals%20and%20non%20goals%20for%20Jackrabbit%203) for
Oak.
+

Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/participating.md (from r1506514, jackrabbit/oak/trunk/oak-doc/src/site/markdown/contributing.md)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/participating.md?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/participating.md&p1=jackrabbit/oak/trunk/oak-doc/src/site/markdown/contributing.md&r1=1506514&r2=1506566&rev=1506566&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/contributing.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/participating.md Wed Jul 24 14:08:45 2013
@@ -15,4 +15,10 @@
    limitations under the License.
   -->
 
-TODO
\ No newline at end of file
+Participating
+-------------
+
+The best place for Oak-related discussions is the [oak-dev@](mailto:oak-dev@jackrabbit.apache.org)
+mailing list. To subscribe, send a message to [oak-dev-subscribe@]
+(mailto:oak-dev-subscribe@jackrabbit.apache.org). Use the [OAK issue tracker]
+(https://issues.apache.org/jira/browse/OAK) to submit issues, comments or patches.
\ No newline at end of file

Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md (from r1506514,
jackrabbit/oak/trunk/oak-doc/src/site/markdown/getting_started.md)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md&p1=jackrabbit/oak/trunk/oak-doc/src/site/markdown/getting_started.md&r1=1506514&r2=1506566&rev=1506566&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/getting_started.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/use_getting_started.md Wed Jul 24 14:08:45
2013
@@ -17,4 +17,4 @@
 
 TODO
 
-[Repository construction](construct.html)
\ No newline at end of file
+[Repository construction](construct.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=1506566&r1=1506565&r2=1506566&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Wed Jul 24 14:08:45 2013
@@ -26,7 +26,6 @@ under the License.
   <body>
     <menu name="Overview">
       <item href="index.html" name="Jackrabbit Oak" />
-      <item href="info.html" name="Project info" />
       <item href="license.html" name="License" />
       <item href="downloads.html" name="Downloads" />
       <item href="from_here.html" name="From here" />
@@ -36,14 +35,15 @@ under the License.
       <item href="microkernel.html" name="Microkernel" />
     </menu>
     <menu name="Using Oak">
-      <item href="getting_started.html" name="Getting Started" />
+      <item href="use_getting_started.html" name="Getting Started" />
       <item href="differences.html" name="Differences to Jackrabbit 2" />
       <item href="dos_and_donts.html" name="Dos and don'ts" />
       <item href="when_things_go_wrong.html" name="When things go wrong" />
     </menu>
     <menu name="Developing Oak">
+      <item href="dev_getting_started.html" name="Getting Started" />
       <item href="resources.html" name="Resources" />
-      <item href="contributing.html" name="Contributing" />
+      <item href="participating.html" name="Participating" />
       <item href="api.html" name="API docs" />
     </menu>
     <menu name="Links">
@@ -59,6 +59,8 @@ under the License.
   <custom>
     <fluidoSkin>
       <sourceLineNumbersEnabled>true</sourceLineNumbersEnabled>
+      <topBarEnabled>true</topBarEnabled>
+      <sideBarEnabled>true</sideBarEnabled>
       <gitHub>
         <projectId>apache/jackrabbit-oak</projectId>
         <ribbonOrientation>right</ribbonOrientation>



Mime
View raw message