[jackrabbit-filevault-package-maven-plugin] branch master updated: documentation: clarify Maven extensions and bindings

[kw...@apache.org]

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

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault-package-maven-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 9bcb32a  documentation: clarify Maven extensions and bindings
9bcb32a is described below

commit 9bcb32a1caeefd7b07416ced36888f9032cc0b75
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Mon Jul 4 13:29:35 2022 +0200

    documentation: clarify Maven extensions and bindings
---
 src/site/markdown/index.md     | 42 ++++++++++++++++++++++++++++++++++++++++--
 src/site/markdown/migrating.md |  2 +-
 2 files changed, 41 insertions(+), 3 deletions(-)

diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 333c67e..8607d2e 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -20,14 +20,51 @@ Introduction
 
 Welcome to Apache Jackrabbit FileVault Package Maven Plugin.
 
-The Apache Jackrabbit FileVault Package Maven plugin is an Apache Maven plugin that simplifies the creation of
-content package Maven artifacts. The content packages can later be used to install content into a JCR repository
+The Apache Jackrabbit FileVault Package Maven Plugin is an Apache Maven Plugin that simplifies the creation of
+content package artifacts. The content packages can later be used to install content into a JCR repository
 using the Apache Jackrabbit FileVault packaging runtime.
 
 Apache Jackrabbit FileVault is a project of the Apache Software Foundation.
 
+Usage
+------
+
+As this Maven plugin comes with [Maven extensions](https://maven.apache.org/guides/mini/guide-using-extensions.html) (for defining custom bindings for `default` lifecycle and a custom artifact handler for type/packaging `content-package`) it needs to be loaded accordingly
+
+```
+<plugin>
+  <groupId>org.apache.jackrabbit</groupId>
+  <artifactId>filevault-package-maven-plugin</artifactId>
+  <version>1.3.0</version>
+  <extensions>true</extensions>
+</plugin>
+```
+
+Further details on the individual goals are available at [Goals](plugin-info.html).
+
+### Plugin bindings for `content-package` packaging
+
+```
+<phases>
+  <process-resources>org.apache.maven.plugins:maven-resources-plugin:resources</process-resources>
+  <compile>org.apache.maven.plugins:maven-compiler-plugin:compile</compile>
+  <generate-test-sources>org.apache.jackrabbit:filevault-package-maven-plugin:generate-metadata</generate-test-sources>
+  <process-test-sources>org.apache.jackrabbit:filevault-package-maven-plugin:validate-files</process-test-sources>
+  <process-test-resources>org.apache.maven.plugins:maven-resources-plugin:testResources</process-test-resources>
+  <test-compile>org.apache.maven.plugins:maven-compiler-plugin:testCompile</test-compile>
+  <test>org.apache.maven.plugins:maven-surefire-plugin:test</test>
+  <package>org.apache.jackrabbit:filevault-package-maven-plugin:package</package>
+  <verify>org.apache.jackrabbit:filevault-package-maven-plugin:validate-package</verify>
+  <install>org.apache.maven.plugins:maven-install-plugin:install</install>
+  <deploy>org.apache.maven.plugins:maven-deploy-plugin:deploy</deploy>
+</phases>
+```
+
+The default bindings for other packagings are documented at [Plugin Bindings for Default Lifecycle Reference](https://maven.apache.org/ref/3.8.6/maven-core/default-bindings.html).
+
 Downloads
 ---------
+
 The latest FileVault Package Maven Plugin sources are available at <https://github.com/apache/jackrabbit-filevault-package-maven-plugin>.
 
 See also our [releases](https://jackrabbit.apache.org/downloads.html) on the Jackrabbit
@@ -43,6 +80,7 @@ Jackrabbit mailing lists as well as links to list archives, please see the [Mail
 
 Latest development
 ------------------
+
 See the [development overview](dev.html) page for more information.
 
 Credits
diff --git a/src/site/markdown/migrating.md b/src/site/markdown/migrating.md
index 131c28e..452d8b1 100644
--- a/src/site/markdown/migrating.md
+++ b/src/site/markdown/migrating.md
@@ -30,7 +30,7 @@ was removed, so that both plugins can now be used in the same project (pom).
 Projects that want to migrate to Jackrabbit's plugin just need to replace the Maven coordinates of the
 content package plugin. And, if the package manager goals are still needed, add Adobe's plugin again.
 
-The Adobe plugin since 1.0.2 does no longer come with any extensions or custom lifecycle mapping, so you can remove `<extensions>true</extension>` on it.
+The Adobe plugin since 1.0.2 does no longer come with any extensions or custom lifecycle mapping, so you can remove `<extensions>true</extensions>` on it.
 
 Example
 -------