You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ra...@apache.org on 2018/08/14 10:10:45 UTC
[sling-whiteboard] branch master updated: updated docs
This is an automated email from the ASF dual-hosted git repository.
radu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git
The following commit(s) were added to refs/heads/master by this push:
new c442b6f updated docs
c442b6f is described below
commit c442b6fbd99c30f4dd2511506c161d8b4d684302
Author: Radu Cotescu <ra...@apache.org>
AuthorDate: Tue Aug 14 12:10:40 2018 +0200
updated docs
---
scripting-resolver/README.md | 14 +++++++++++++-
scripting-resolver/examples/README.md | 9 +++++++++
.../org-apache-sling-scripting-resolver/README.md | 4 ++--
3 files changed, 24 insertions(+), 3 deletions(-)
diff --git a/scripting-resolver/README.md b/scripting-resolver/README.md
index 90aef7f..88740be 100644
--- a/scripting-resolver/README.md
+++ b/scripting-resolver/README.md
@@ -27,10 +27,22 @@ Advantages of the new design:
* backwards compatibility will be handled the same way we do for Java APIs, allowing for smoother upgrades and delivery of new features
* such a model could be described through Apache Sling's Feature Model [3], allowing an application to be built using a mix & match technique for collecting the components it requires for rendering.
-
## Further reading
For a detailed view of how this project works please check each module's documentations plus the provided examples.
+## Building
+The following instructions should allow you to correctly build this project:
+
+```bash
+git clone https://github.com/apache/sling-whiteboard.git
+git submodule update --init
+cd scripting-resolver
+# if you want to access the examples directly - check the examples/README.md file
+mvn clean verify -Pexample
+# if you want to run the IT
+mvn clean verify -Pit
+```
+
## References
[1] - https://wiki.apache.org/jackrabbit/DavidsModel
diff --git a/scripting-resolver/examples/README.md b/scripting-resolver/examples/README.md
index d605c03..1d44d8a 100644
--- a/scripting-resolver/examples/README.md
+++ b/scripting-resolver/examples/README.md
@@ -28,5 +28,14 @@ package your scripts into OSGi bundles:
1. `<sling>/content/srr/examples/hi.html` - automatically wired to the `org.apache.sling.scripting.examplebundle.hi/1.0.0` resource type
2. `<sling>/content/srr/examples/hi-v1.html` - explicitly wired to the `org.apache.sling.scripting.examplebundle.hi/1.0.0` resource type
+ 3. [`org.apache.sling.scripting.examplebundle.precompiled`](./org-apache-sling-scripting-examplebundle-precompiled):
+ * provides the `org.apache.sling.scripting.examplebundle.precompiled.hello` resource type
+ * the resource type is provided in two versions (`1.0.0` and `2.0.0`)
+ * it has a main script (`hello.html`) and some selector scripts
+ * initial content is available at:
+ 1. `<sling>/content/srr/examples/precompiled-hello.html` - automatically wired to the `org.apache.sling.scripting.examplebundle.hello/2.0.0` resource type
+ 2. `<sling>/content/srr/examples/precompiled-hello-v1.html` - explicitly wired to the `org.apache.sling.scripting.examplebundle.hello/1.0.0` resource type
+ 3. `<sling>/content/srr/examples/precompiled-hello-v2.html` - explicitly wired to the `org.apache.sling.scripting.examplebundle.hello/2.0.0` resource type
+
The integration tests using these bundles can be found [here](../org-apache-sling-scripting-resolver/src/test/java/org/apache/sling/scripting/resolver/internal) and
you can find instructions to start a running sling instance with the provided examples [here](../org-apache-sling-scripting-resolver/#Example).
diff --git a/scripting-resolver/org-apache-sling-scripting-resolver/README.md b/scripting-resolver/org-apache-sling-scripting-resolver/README.md
index 1ce2489..2391215 100644
--- a/scripting-resolver/org-apache-sling-scripting-resolver/README.md
+++ b/scripting-resolver/org-apache-sling-scripting-resolver/README.md
@@ -66,7 +66,7 @@ Short answer: exactly like you deploy your code, preferably right next to it. Pa
To run the integration tests do:
```
-mvn clean install -Pit
+mvn clean verify -Pit
```
### Example
@@ -74,7 +74,7 @@ mvn clean install -Pit
To play around with a sling instance on localhost port 8080 (override with -Dhttp.port=<port>) that has the [examples](../examples) installed run:
```
-mvn clean install -Pexample
+mvn clean verify -Pexample
```
## Resources