svn commit: r1513927 - /jackrabbit/oak/trunk/oak-doc/README.md

[md...@apache.org]

Author: mduerig
Date: Wed Aug 14 15:18:15 2013
New Revision: 1513927

URL: http://svn.apache.org/r1513927
Log:
OAK-301: Document Oak
Adding readme with instruction for how to build and deploy the documentation

Added:
    jackrabbit/oak/trunk/oak-doc/README.md

Added: jackrabbit/oak/trunk/oak-doc/README.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/README.md?rev=1513927&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/README.md (added)
+++ jackrabbit/oak/trunk/oak-doc/README.md Wed Aug 14 15:18:15 2013
@@ -0,0 +1,25 @@
+Oak Documentation
+=================
+
+The Oak documentation lives as Markdown files in `src/site/markdown` such that it easy to view
+e.g. from GitHub. Alternatively the Maven site plugin can be used to build and deploy a web site
+as follows:
+
+From the reactor use
+
+    mvn site
+
+to build the site without Javadoc or
+
+    mvn site -Psite-with-javadoc
+
+to build the site with Javadoc. Review the site at `oak-doc/target/site`.
+
+Then deploy the site to `http://jackrabbit.apache.org/oak/docs/` using
+
+    mvn site-deploy
+
+Finally review the site at `http://jackrabbit.apache.org/oak/docs/index.html`.
+
+Every committer should be able to deploy the site. No fiddling with credentials needed since
+deployment is done via svn commit to `https://svn.apache.org/repos/asf/jackrabbit/site/live/oak/docs`.