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 2020/03/27 17:10:35 UTC
[sling-org-apache-sling-scripting-bundle-tracker-it] branch master
updated: updated examples readme
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-org-apache-sling-scripting-bundle-tracker-it.git
The following commit(s) were added to refs/heads/master by this push:
new cf3f259 updated examples readme
cf3f259 is described below
commit cf3f2590dc86df709e82268ac348273b3faa9e0b
Author: Radu Cotescu <ra...@apache.org>
AuthorDate: Fri Mar 27 18:10:07 2020 +0100
updated examples readme
---
README.md | 2 +-
examples/README.md | 48 ++++--------------------------------------------
2 files changed, 5 insertions(+), 45 deletions(-)
diff --git a/README.md b/README.md
index 34ae6a7..00f430e 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ This project provides the integration tests and some test examples for the [Apac
### Example
-To play around with a sling instance on localhost port 8080 (override with -Dhttp.port=<port>) that has the [examples](../../examples) installed run:
+To play around with a sling instance on localhost port 8080 (override with -Dhttp.port=<port>) that has the [examples](tree/master/examples) installed run:
```
mvn clean verify -Pexample
diff --git a/examples/README.md b/examples/README.md
index 12d5904..5232171 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -4,51 +4,11 @@ Examples
Because some code is worth a thousand words...
The examples provided by the project also serve as integration tests, therefore they should always work and be relatively up-to-date.
-Four bundles showcase how the [`org.apache.sling.scripting.bundle.tracker`](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker/tree/master/README.md) works and how you can
-package your scripts into OSGi bundles:
+Four bundles showcase how the [`org.apache.sling.scripting.bundle.tracker`](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker/tree/master/README.md).
- 1. [`org.apache.sling.scripting.examplebundle`](./org-apache-sling-scripting-examplebundle):
- * provides the `org.apache.sling.scripting.examplebundle.hello` resource type
- * its scripts are packed as is and compiled on the platform
- * 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/hello.html` - automatically wired to the `org.apache.sling.scripting.examplebundle.hello/2.0.0` resource type
- 2. `<sling>/content/srr/examples/hello-v1.html` - explicitly wired to the `org.apache.sling.scripting.examplebundle.hello/1.0.0` resource type
- 3. `<sling>/content/srr/examples/hello-v2.html` - explicitly wired to the `org.apache.sling.scripting.examplebundle.hello/2.0.0` resource type
+All the test endpoints will be in the resource tree under the `/content/bundled-scripts/` folder.
- 2. [`org.apache.sling.scripting.examplebundle.hi`](./org-apache-sling-scripting-examplebundle.hi):
- * provides the `org.apache.sling.scripting.examplebundle.hi` resource type; it extends
- `org.apache.sling.scripting.examplebundle.hello;version=[1.0.0,2.0.0)` - the `extends` file will be used by the
- [`org.apache.sling.scripting.maven.plugin`](../org-apache-sling-scripting-maven-plugin) to correctly generate the
- `Require-Capabilities`
- * the resource type is provided in one version (`1.0.0`)
- * it has a selector script (`h.html`), essentially overriding the same selector script from
- `org.apache.sling.scripting.examplebundle.hello/1.0.0`
- * initial content is available at:
- 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
-
- 4. [`org.apache.sling.scripting.examplebundle.ohhi`](./org-apache-sling-scripting-examplebundle.ohhi):
- * provides the `org.apache.sling.scripting.examplebundle.ohhi` resource type; it extends
- `org.apache.sling.scripting.examplebundle.hi;version=[1.0.0,2.0.0)` - the `extends` file will be used by the
- [`org.apache.sling.scripting.maven.plugin`](../org-apache-sling-scripting-maven-plugin) to correctly generate the
- `Require-Capabilities`
- * the resource type is provided in one version (`1.0.0`)
- * it has a selector script (`h.html`), essentially overriding the same selector script from
- `org.apache.sling.scripting.examplebundle.hi/1.0.0`
- * initial content is available at:
- 1. `<sling>/content/srr/examples/ohhi.html` - automatically wired to the `org.apache.sling.scripting.examplebundle.ohhi/1.0.0` resource type
- 2. `<sling>/content/srr/examples/ohhi-v1.html` - explicitly wired to the `org.apache.sling.scripting.examplebundle.ohhi/1.0.0` resource type
+All the servlets registered by the Apache Sling Scripting Bundle Tracker will have their providers registered in the `/apps/org.apache.sling.scripting.examplebundle.*` and `/apps/sling/scripting/examplebundle*` folders.
The integration tests using these bundles can be found [here](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker-it/tree/master/it/src/test/java/org/apache/sling/scripting/bundle/tracker/it) and
-you can find instructions to start a running sling instance with the provided examples [here](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker-it/tree/master/it/#Example).
+you can find instructions to start a running sling instance with the provided examples [here](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker-it#example).