You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by st...@apache.org on 2018/11/05 15:17:19 UTC

[sling-whiteboard] 01/02: Revert "README added"

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

stefanegli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git

commit a3fa0de23726dc41d8b1bebaa984846822826491
Author: Stefan Egli <st...@apache.org>
AuthorDate: Mon Nov 5 16:16:23 2018 +0100

    Revert "README added"
    
    This reverts commit fef316a603fc3af16182954ad30f7b4a33de53ea.
---
 README.md | 26 ++++++++------------------
 1 file changed, 8 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index f921cc3..90ccf12 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,15 @@
+[<img src="http://sling.apache.org/res/logos/sling.png"/>](http://sling.apache.org)
 
-Sling Capabilities - Oak Repository Descriptors
-===============================================
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
-This module is a prototype exposing a select set of Oak Repository Descriptors as [Sling Capabilities](https://github.com/apache/sling-org-apache-sling-capabilities).
+# Apache Sling Whiteboard
 
-Might make sense to merge it at some point with the [Jcr capabilities module](https://github.com/apache/sling-org-apache-sling-capabilities-jcr)
+This module is part of the [Apache Sling](https://sling.apache.org) project.
 
-Usage
------
-The OakDescriptorSource will expose only those repository descriptor keys that are in a configured list (can use regex). So for exposing a descriptor key it must first be added to the OakDescriptorSource.keyWhitelist config.
+This is the whiteboard area of Apache Sling. It contains experimental code that is not intended to be used in production.
 
-The capabilities call will then return all whitelisted descriptor values, eg:
+Sling committers are welcome to use this repository for prototypes and other experimental work. Please separate your code in distinct folders with self-explanatory names so we understand what's in there easily.
 
-    {
-      "org.apache.sling.capabilities": {
-        "data": {
-          "org.apache.sling.oak.descriptor": {
-            "jcr.repository.name": "Apache Jackrabbit Oak",
-            "jcr.repository.vendor": "The Apache Software Foundation"
-          }
-        }
-      }
-    }
+We currently do not release code from this repository, if a module needs to be released please discuss its "promotion" on the Sling dev list and then move it to its own repository.
 
+Older whiteboard experiments can be found at https://svn.apache.org/repos/asf/sling/whiteboard/ - the plan is to only move code that's being actively worked on and leave the rest there.