sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r...@apache.org
Subject [sling-org-apache-sling-scripting-bundle-tracker] branch master updated: updated links and description
Date Mon, 10 Dec 2018 12:02:01 GMT
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.git


The following commit(s) were added to refs/heads/master by this push:
     new ceb6d01  updated links and description
ceb6d01 is described below

commit ceb6d014aaac192a7678df4ee380927a12032d2a
Author: Radu Cotescu <cotescu@adobe.com>
AuthorDate: Mon Dec 10 12:38:34 2018 +0100

    updated links and description
---
 README.md | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 627ea77..c9e5879 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-Apache Sling Scripting Resolver (WIP, name not final)
+Apache Sling Scripting Bundle Tracker
 ====
 
 ## What
-The `org.apache.sling.scripting.bundle.tracker` bundle represents an add-on module that can
be deployed on a Sling 10 instance to
+The `org.apache.sling.scripting.bundle.tracker` bundle represents an add-on module that can
be deployed on a Sling 10 instance or newer to
 enhance the scripting resolving capabilities. Being an add-on, the bundle hooks into Sling's
current mechanisms for
 content-to-servlet resolution and essentially acts as a service registration broker for bundles
providing scripting
 capabilities (more details in the ["How"](#how) section).
@@ -22,7 +22,7 @@ context. As such, scripts should be handled like code:
   3. they have a _developer audience_.
 
 ## How
-Being built around a `BundleTrackerCustomizer` [2], the Scripting Resolver monitors the instance's
bundles wired to itself and
+Being built around a `BundleTrackerCustomizer` [2], the Scripting Bundle Tracker monitors
the instance's bundles wired to itself and
 scans the ones providing a `sling.resourceType` capability [3]. The wiring is created by
placing a `Require-Capability` header in
 the bundles that provide the `sling.resourceType` capability:
 
@@ -56,14 +56,14 @@ Short answer: exactly like you deploy your code, preferably right next
to it. Pa
   3. inside each `resourceType` folder create a `Version` folder; this has to follow the
Semantic Versioning constraints described at [1];
   4. add your scripts, using the same naming conventions that you were used to from before
[4];
   5. manually define your provide and require capabilities; just kidding; add the
-  [`org.apache.sling.scripting.maven.plugin`](../org-apache-sling-scripting-maven-plugin)
to your build section and add its required
-  properties in the `maven-bundle-plugin`'s instructions (check [this](../examples/org-apache-sling-scripting-examplebundle/pom.xml)
+  [`scriptingbundle-maven-plugin`](https://github.com/apache/sling-scriptingbundle-maven-plugin)
to your build section and add its required
+  properties in the `maven-bundle-plugin`'s instructions (check [this](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker-it/tree/master/examples/org-apache-sling-scripting-examplebundle/pom.xml)
   example);
   6. `mvn clean sling:install`.
 
 ### Integration Tests
 
-To run the integration tests do:
+The integration tests are provided by the [`org.apache.sling.scripting.bundle.tracker.it`](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker-it)
project. To run the integration tests execute the following command:
 
 ```
 mvn clean verify -Pit
@@ -71,12 +71,14 @@ mvn clean verify -Pit
 
 ### 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](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker-it/tree/master/examples/)
installed run:
 
 ```
 mvn clean verify -Pexample
 ``` 
 
+from the [`org.apache.sling.scripting.bundle.tracker.it`](https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker-it)
project.
+
 ## Resources
 [1] - https://semver.org/  
 [2] - https://osgi.org/javadoc/r6/core/org/osgi/util/tracker/BundleTrackerCustomizer.html
 


Mime
View raw message