[maven-resolver] branch update-redisson-hz-doco created (now 190836e)

[cs...@apache.org]

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

cstamas pushed a change to branch update-redisson-hz-doco
in repository https://gitbox.apache.org/repos/asf/maven-resolver.git.


      at 190836e  Updated Redisson and HZ doco

This branch includes the following new commits:

     new 190836e  Updated Redisson and HZ doco

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

[maven-resolver] 01/01: Updated Redisson and HZ doco

[cs...@apache.org]

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

cstamas pushed a commit to branch update-redisson-hz-doco
in repository https://gitbox.apache.org/repos/asf/maven-resolver.git

commit 190836ee259f203d1e38ea11167ba0340d451d13
Author: Tamas Cservenak <ta...@cservenak.net>
AuthorDate: Thu Oct 7 11:49:20 2021 +0200

    Updated Redisson and HZ doco
    
    Make it clear that "it only works with Sisu" is meant for integrators,
    not "end users" wishing to use them with Maven.
---
 .../src/site/markdown/index.md.vm                             | 11 +++++++++--
 .../src/site/markdown/index.md.vm                             | 11 +++++++++--
 2 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/maven-resolver-named-locks-hazelcast/src/site/markdown/index.md.vm b/maven-resolver-named-locks-hazelcast/src/site/markdown/index.md.vm
index cdd6ebd..d8cacb1 100644
--- a/maven-resolver-named-locks-hazelcast/src/site/markdown/index.md.vm
+++ b/maven-resolver-named-locks-hazelcast/src/site/markdown/index.md.vm
@@ -32,12 +32,19 @@ Out of the box "hazelcast" (distributed) named lock implementations are the foll
 
 ${esc.hash}${esc.hash} Open Issues/Notes
 
-- It only works when Sisu DI is used and not the bundled `AetherModule` or
-  `ServiceLocator` (Maven uses Sisu dependency injection).
 - Usage from plugins has not been tested yet.
 - The `furnace-maven-plugin` does not work this implementation because it uses `ServiceLocator` instead
   of dependency injection.
 
+${esc.hash}${esc.hash} Open Issues/Notes for Maven Resolver integrators
+
+To use this implementation within your project, depending on how you integrate, you have following options:
+- If you use Sisu DI, then all you need is to provide this module (and it's dependencies) on classpath and you are done.
+- If you use Guice, you need to add this module (and it's dependencies) upfront, and bind them explicitly.
+- If you use ServiceLocator, be aware it is deprecated and you should move away from it. In this case, simplest is
+  to roll your own "bootstrap" class that does pretty much same thing as ServiceLocator was, and extend it to
+  instantiate these components as well.
+
 ${esc.hash}${esc.hash} Installation/Testing
 
 - Create the directory `${maven.home}/lib/ext/hazelcast/`.
diff --git a/maven-resolver-named-locks-redisson/src/site/markdown/index.md.vm b/maven-resolver-named-locks-redisson/src/site/markdown/index.md.vm
index efb2eef..c7e6a49 100644
--- a/maven-resolver-named-locks-redisson/src/site/markdown/index.md.vm
+++ b/maven-resolver-named-locks-redisson/src/site/markdown/index.md.vm
@@ -31,12 +31,19 @@ Out of the box "redisson" (distributed) named lock implementations are the follo
 
 ${esc.hash}${esc.hash} Open Issues/Notes
 
-- It only works when Sisu DI is used and not the bundled `AetherModule` or
-  `ServiceLocator` (Maven uses Sisu dependency injection).
 - Usage from plugins has not been tested yet.
 - The `furnace-maven-plugin` does not work this implementation because it uses `ServiceLocator` instead
   of dependency injection.
 
+${esc.hash}${esc.hash} Open Issues/Notes for Maven Resolver integrators
+
+To use this implementation within your project, depending on how you integrate, you have following options:
+- If you use Sisu DI, then all you need is to provide this module (and it's dependencies) on classpath and you are done.
+- If you use Guice, you need to add this module (and it's dependencies) upfront, and bind them explicitly.
+- If you use ServiceLocator, be aware it is deprecated and you should move away from it. In this case, simplest is
+  to roll your own "bootstrap" class that does pretty much same thing as ServiceLocator was, and extend it to
+  instantiate these components as well.
+
 ${esc.hash}${esc.hash} Installation/Testing
 
 - Create the directory `${maven.home}/lib/ext/redisson/`.