update to newest parent
improve Maven site
diff --git a/pom.xml b/pom.xml
index 6bd3daa..bd4f97a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,7 +22,7 @@
<parent>
<groupId>org.apache.sling</groupId>
<artifactId>sling</artifactId>
- <version>44</version>
+ <version>45</version>
<relativePath />
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -40,7 +40,7 @@
<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/sling-scriptingbundle-maven-plugin.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-scriptingbundle-maven-plugin.git</developerConnection>
- <url>https://gitbox.apache.org/repos/asf?p=sling-scriptingbundle-maven-plugin.git</url>
+ <url>https://github.com/apache/sling-scriptingbundle-maven-plugin/tree/${project.scm.tag}</url>
<tag>HEAD</tag>
</scm>
@@ -50,6 +50,7 @@
<site.jira.version.id>12344664,12347157,12348422,12350010</site.jira.version.id>
<maven.site.path>${project.artifactId}-archives/${project.artifactId}-LATEST</maven.site.path>
<project.build.outputTimestamp>2020-01-22T15:10:38Z</project.build.outputTimestamp>
+ <github.project.id>apache/sling-scriptingbundle-maven-plugin</github.project.id>
</properties>
<build>
@@ -57,7 +58,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
- <version>${maven.version}</version>
<executions>
<execution>
<id>mojo-descriptor</id>
diff --git a/src/site/markdown/bnd.md b/src/site/markdown/bnd.md
new file mode 100644
index 0000000..9ff7a57
--- /dev/null
+++ b/src/site/markdown/bnd.md
@@ -0,0 +1,29 @@
+Starting with version `0.3.0`, the JAR also provides a [bnd plugin](https://bnd.bndtools.org/chapters/870-plugins.html). The simplest configuration (where the defaults are used)
+would look like:
+
+```
+<plugin>
+ <groupId>biz.aQute.bnd</groupId>
+ <artifactId>bnd-maven-plugin</artifactId>
+ <dependencies>
+ <dependency>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
+</plugin>
+```
+
+and the following instructions added to your project's `bnd.bnd` file:
+
+```
+Require-Capability: osgi.extender;filter:="(&(osgi.extender=sling.scripting)(version>=1.0.0)(!(version>=2.0.0)))"
+-plugin: org.apache.sling.scriptingbundle.plugin.bnd.BundledScriptsScannerPlugin
+```
+
+The bnd plugin supports the same configuration options as the [Maven `metadata` goal](metadata-mojo.html), using the exact same name for its configuration
+properties. Multiple values need to be provided as a quoted comma-separated values list (e.g.
+`sourceDirectories="src/main/scripts,src/main/resources/javax.script"`, `scriptEngineMappings="html:htl,js:rhino"`).
+
+For a general usage description please refer to [Usage](usage.html).
\ No newline at end of file
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 9e8b21e..2076092 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,20 +1,20 @@
-The Apache Sling Scripting Bundle Maven Plugin helps with generating the OSGi bundle
+The Apache Sling Scripting Bundle Maven Plugin helps with generating the OSGi bundle capability
headers that bundles which provide embedded or precompiled scripts for server-side
rendering in an Apache Sling application require in order to have themselves wired up to the
-Apache Sling Servlets Resolver. When executed, the plugin will define two project properties
+Apache Sling Servlets Resolver. Details on the necessary headers are described at [Bundled Scripts](https://sling.apache.org/documentation/bundles/scripting.html#bundled-scripts). When executed, the plugin will define two project properties
(`org.apache.sling.scriptingbundle.maven.plugin.Require-Capability` and
`org.apache.sling.scriptingbundle.maven.plugin.Provide-Capability`) which can be used to
populate the corresponding bundle headers.
Bundles that get extended by the
[`org.apache.sling.servlets.resolver`](https://github.com/apache/sling-org-apache-sling-servlets-resolver)
-with these `Requirements` and`Capabilities` will have their scripts made available automatically with added
+with these `Requirements` and `Capabilities` will have their scripts made available automatically with added
versioning and dependency support.
Manually defining the `Require-Capability` and `Provide-Capability` bundle headers is error-prone and unnecessary,
as they can be derived from the file-system layout required for scripts by the resolver (for the most part).
-Starting with version `0.3.0`, the JAR also provides a BND plugin.
+Starting with version `0.3.0`, the JAR also provides a [bnd plugin](bnd.html).
## Usage
General instructions on how to use the Scripting Bundle Maven Plugin can be found on the
diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm
index 0c1444f..626e289 100644
--- a/src/site/markdown/usage.md.vm
+++ b/src/site/markdown/usage.md.vm
@@ -6,7 +6,7 @@
$h2 Usage
-The plugin can be used either as a regular Maven plugin or as a BND plugin.
+The plugin can be used either as a regular Maven plugin or as a [bnd plugin](bnd.html).
No matter which approach you choose, the plugin will by default look for scripts in two project directories:
@@ -14,7 +14,7 @@
2. `src/main/resources/javax.script` - this folder will contain scripts that will be embedded as is
The structure in these source directories should then follow the normal way of structuring scripts in an Apache Sling application. For more
-details, check the [URL to Script Resolution](https://sling.apache.org/documentation/the-sling-engine/url-to-script-resolution.html#script-locations)
+details, check the [Sling Scripting](https://sling.apache.org/documentation/bundles/scripting.html#resource-script-naming-conventions)
page. In addition to the normal way of structuring scripts in the file tree, the plugin provides some additional features:
1. Resource Type Versioning<br/>
@@ -55,12 +55,10 @@
For more complex examples head over to https://github.com/apache/sling-org-apache-sling-scripting-bundle-tracker-it/tree/master/examples.
-$h3 So how do I use the plugin?
-
-$h4 Maven Plugin
+$h3 Configure Maven Plugin
When used as a Maven plugin, the generated `Require-Capability` and `Provide-Capability` headers values are made available via
-properties:
+Maven project properties:
```
${org.apache.sling.scriptingbundle.maven.plugin.Require-Capability}
@@ -105,31 +103,3 @@
The `osgi.extender` requirement is mandatory to have the bundle wired up to the Apache Sling Servlets Resolver, but this should be manually
defined by the developers, so that their bundle is correctly wired up to whatever version of the Servlets Resolver is available on the
destination platform.
-
-$h4 BND Plugin
-
-Starting with version `0.3.0`, the JAR also provides a BND plugin. The simplest configuration (where the defaults are used)
-would look like:
-```
-<plugin>
- <groupId>biz.aQute.bnd</groupId>
- <artifactId>bnd-maven-plugin</artifactId>
- <dependencies>
- <dependency>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- </dependency>
- </dependencies>
-</plugin>
-```
-
-and the following instructions added to your project's `bnd.bnd` file:
-```
-Require-Capability: osgi.extender;filter:="(&(osgi.extender=sling.scripting)(version>=1.0.0)(!(version>=2.0.0)))"
--plugin: org.apache.sling.scriptingbundle.plugin.bnd.BundledScriptsScannerPlugin
-```
-
-The BND plugin supports the same configuration options as the Maven `metadata` goal, using the exact same name for its configuration
-properties. Multiple values need to be provided as a quoted comma separated values list (e.g.
-`sourceDirectories="src/main/scripts,src/main/resources/javax.script"`, `scriptEngineMappings="html:htl,js:rhino"`).
diff --git a/src/site/site.xml b/src/site/site.xml
index 2592253..b3b845e 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -19,22 +19,13 @@
under the License.
-->
<project>
- <skin>
- <groupId>org.apache.maven.skins</groupId>
- <artifactId>maven-fluido-skin</artifactId>
- <version>1.6</version>
- </skin>
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
+ <item name="Bnd Plugin" href="bnd.html"/>
</menu>
<menu ref="reports"/>
</body>
- <custom>
- <fluidoSkin>
- <sourceLineNumbersEnabled>true</sourceLineNumbersEnabled>
- </fluidoSkin>
- </custom>
</project>
