[sling-org-apache-sling-nosql-couchbase-resourceprovider] 06/28: SLING-4381 update README

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rombert pushed a commit to annotated tag org.apache.sling.nosql.couchbase-resourceprovider-1.0.0
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-nosql-couchbase-resourceprovider.git

commit ed6fd8ea384efb8995781c7f03416f23aa88214f
Author: Stefan Seifert <ss...@apache.org>
AuthorDate: Wed May 20 16:33:00 2015 +0000

    SLING-4381 update README
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/contrib/nosql/couchbase-resourceprovider@1680631 13f79535-47bb-0310-9956-ffa450edef68
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 53be13a..c47f479 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,21 @@ Configuration on deployment
 * Additionally a factory configuration for "Apache Sling NoSQL Couchbase Resource Provider Factory" defines the root of the resource tree that should be stored in Couchbase
 
 
+Couchbase Views for path-based access
+-------------------------------------
+
+For list and delete operations two couchbase views have to be defined and published in the bucket that is used by the resource provider.
+
+Steps to create those views:
+* Log into Couchbase Console
+* Go to "Views" and select the correct bucket
+* Add a new design document via "Create Development View" and name it "_design/dev_resourceIndex" (the prefix "_design/dev_" is added automatically)
+* Use the name "ancestorPath" for the first view that is created together with the design document
+* Paste the view code from [ancestorPath.js](src/main/couchbase-views/ancestorPath.js) into the editor and save it
+* Create another view named "parentPath", paste the view code from [parentPath.js](src/main/couchbase-views/ancestorPath.js) and save it
+* Publish the design document so the views are production views
+
+
 Run integration tests
 ---------------------
 
@@ -21,3 +36,4 @@ To run the integration tests you have to set up a real couchbase server and run
 ```
 mvn -Pcouchbase-integration-test -DcouchbaseHosts=localhost:8091 -DbucketName=test integration-test
 ```
+

-- 
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.