Update documentation and add new documentation for new goals

Signed-off-by: James R. Perkins <[email protected]>
wildfly · Feb 1, 2022 · 99f4dd0 · 99f4dd0
1 parent 660a874
commit 99f4dd0
Show file tree

Hide file tree

Showing 127 changed files with 54,959 additions and 2,946 deletions.
diff --git a/docs/add-resource-example.html b/docs/add-resource-example.html
@@ -75,15 +75,13 @@
 
 
 
-
-
 
 
 
 <!DOCTYPE html>
 <!--
- Generated by Apache Maven Doxia the 2021-10-11
- Rendered using Docs Maven Skin 2.2.4 (https://github.com/Bernardo-MG/docs-maven-skin)
+ Generated by Apache Maven Doxia the 2022-01-31
+ Rendered using Docs Maven Skin 2.2.5 (https://github.com/Bernardo-MG/docs-maven-skin)
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
 <head>
@@ -139,7 +137,7 @@
                <span class="navbar-toggler-icon"></span>
             </button>
 
-            <small class="navbar-text d-none d-md-block"><span id="navbar-version">2.1.0.Final</span> (<time id="navbar-date">2021-10-11</time>)</small>
+            <small class="navbar-text d-none d-md-block"><span id="navbar-version">3.0.0.Beta1</span> (<time id="navbar-date">2022-01-31</time>)</small>
             <div class="collapse navbar-collapse" id="navbar-main-menu">
                 <ul class="nav navbar-nav ms-auto">
                     <li class="nav-item dropdown">
@@ -159,6 +157,8 @@
                             <li><a class="dropdown-item" href="complex-example.html" title="Complex Example">Complex Example</a></li>
                             <li><a class="dropdown-item" href="execute-commands-example.html" title="Execute Commands Example">Execute Commands Example</a></li>
                             <li><a class="dropdown-item" href="run-example.html" title="Run Example">Run Example</a></li>
+                            <li><a class="dropdown-item" href="package-example.html" title="Package Example">Package Example</a></li>
+                            <li><a class="dropdown-item" href="provision-example.html" title="Provision Example">Provision Example</a></li>
                         </ul>
                     </li>
                     <li class="nav-item dropdown">
@@ -186,7 +186,7 @@ <h1 id="adding-resources-examples">Adding Resources Examples</h1>
 </header> 
 <p>The add-resources goal allows you to add resources such as datsources etc to a running WildFly instance.</p>
 <section> 
- <h2 id="adding-datasources">Adding datasources</h2> 
+ <h2 id="adding-datasources"><a name="Adding_datasources"></a>Adding datasources</h2> 
  <p>This can be combined with the <a href="add-resource-mojo.html">add-resource</a> goal to automatically deploy the datasource drivers.</p> 
  <p>The example below shows how to add a datasource that uses the default h2 database:</p> 
  <div> 
@@ -198,7 +198,7 @@ <h2 id="adding-datasources">Adding datasources</h2>
             &lt;plugin&gt;
                 &lt;groupId&gt;org.wildfly.plugins&lt;/groupId&gt;
                 &lt;artifactId&gt;wildfly-maven-plugin&lt;/artifactId&gt;
-                &lt;version&gt;2.1.0.Final&lt;/version&gt;
+                &lt;version&gt;3.0.0.Beta1&lt;/version&gt;
                 &lt;executions&gt;
                     &lt;execution&gt;
                         &lt;id&gt;add-datasource&lt;/id&gt;
@@ -243,7 +243,7 @@ <h2 id="adding-datasources">Adding datasources</h2>
             &lt;plugin&gt;
                 &lt;groupId&gt;org.wildfly.plugins&lt;/groupId&gt;
                 &lt;artifactId&gt;wildfly-maven-plugin&lt;/artifactId&gt;
-                &lt;version&gt;2.1.0.Final&lt;/version&gt;
+                &lt;version&gt;3.0.0.Beta1&lt;/version&gt;
                 &lt;executions&gt;
                     &lt;execution&gt;
                         &lt;id&gt;deploy-postgresql&lt;/id&gt;
@@ -325,7 +325,7 @@ <h2 id="adding-datasources">Adding datasources</h2>
  <p>The xml tags in the &lt;properties&gt; element correspond directly to the DMR nodes in the corresponding management operation. If you need to use DMR nodes of a non-primitive type then you must prefix the value with the !! escape sequence, which will cause the value to be interpreted as a string representation of a DMR node. For example in the &lt;xa-data-source-properties&gt; element about &lt;xa-datasource-properties&gt; is a DMR property list.</p>
 </section>
 <section> 
- <h2 id="adding-other-resources">Adding other resources</h2> 
+ <h2 id="adding-other-resources"><a name="Adding_other_resources"></a>Adding other resources</h2> 
  <p>It is also possible to deploy resources other than datasources, the example below shows how to deploy a JMS queue:</p> 
  <div> 
   <div> 
@@ -338,7 +338,7 @@ <h2 id="adding-other-resources">Adding other resources</h2>
             &lt;plugin&gt;
                 &lt;groupId&gt;org.wildfly.plugins&lt;/groupId&gt;
                 &lt;artifactId&gt;wildfly-maven-plugin&lt;/artifactId&gt;
-                &lt;version&gt;2.1.0.Final&lt;/version&gt;
+                &lt;version&gt;3.0.0.Beta1&lt;/version&gt;
                 &lt;executions&gt;
                     &lt;execution&gt;
                         &lt;id&gt;add-jms-queue&lt;/id&gt;
@@ -370,7 +370,7 @@ <h2 id="adding-other-resources">Adding other resources</h2>
  </div> 
 </section>
 <section> 
- <h2 id="adding-resources-in-domain-mode">Adding resources in domain mode</h2> 
+ <h2 id="adding-resources-in-domain-mode"><a name="Adding_resources_in_domain_mode"></a>Adding resources in domain mode</h2> 
  <p>Adding resources in domain mode works the same as the examples above, except you need to add the &lt;profiles&gt; property as well as specify at least one profile.</p> 
  <div> 
   <div> 
@@ -383,7 +383,7 @@ <h2 id="adding-resources-in-domain-mode">Adding resources in domain mode</h2>
             &lt;plugin&gt;
                 &lt;groupId&gt;org.wildfly.plugins&lt;/groupId&gt;
                 &lt;artifactId&gt;wildfly-maven-plugin&lt;/artifactId&gt;
-                &lt;version&gt;2.1.0.Final&lt;/version&gt;
+                &lt;version&gt;3.0.0.Beta1&lt;/version&gt;
                 &lt;executions&gt;
                     &lt;execution&gt;
                         &lt;id&gt;add-datasource&lt;/id&gt;
@@ -428,12 +428,12 @@ <h2 id="adding-resources-in-domain-mode">Adding resources in domain mode</h2>
     </div>
     <div id="footer-info" class="bg-bg-primary ps-2 pb-1 w-100">
         <div id="footer-custom-content"><div class="float-md-end"><a href="http://www.redhat.com/"><span class="fw-bold btn-link">Sponsored by</span> <img class="img-fluid" src="https://www.wildfly.org/assets/img/redhat_reversed.svg"></a></div></div>
-        <div> <span class="far fa-copyright"></span>2021
+        <div> <span class="far fa-copyright"></span>2022
 <a href="http://www.jboss.org">JBoss by Red Hat</a>
 -
 <a href="http://repository.jboss.org/licenses/lgpl-2.1.txt">GNU Lesser General Public License v2.1 only</a> 
 </div>
-        <div>Rendered using <a href="https://github.com/Bernardo-MG/docs-maven-skin">Docs Maven Skin</a> 2.2.4</div>
+        <div>Rendered using <a href="https://github.com/Bernardo-MG/docs-maven-skin">Docs Maven Skin</a> 2.2.5</div>
     </div>
 </footer>
 <script src="./lib/bootstrap/dist/js/bootstrap.min.js"></script>

diff --git a/docs/add-resource-mojo.html b/docs/add-resource-mojo.html
@@ -75,15 +75,13 @@
 
 
 
-
-
 
 
 
 <!DOCTYPE html>
 <!--
- Generated by Apache Maven Doxia the 2021-10-11
- Rendered using Docs Maven Skin 2.2.4 (https://github.com/Bernardo-MG/docs-maven-skin)
+ Generated by Apache Maven Doxia the 2022-01-31
+ Rendered using Docs Maven Skin 2.2.5 (https://github.com/Bernardo-MG/docs-maven-skin)
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
 <head>
@@ -139,7 +137,7 @@
                <span class="navbar-toggler-icon"></span>
             </button>
 
-            <small class="navbar-text d-none d-md-block"><span id="navbar-version">2.1.0.Final</span> (<time id="navbar-date">2021-10-11</time>)</small>
+            <small class="navbar-text d-none d-md-block"><span id="navbar-version">3.0.0.Beta1</span> (<time id="navbar-date">2022-01-31</time>)</small>
             <div class="collapse navbar-collapse" id="navbar-main-menu">
                 <ul class="nav navbar-nav ms-auto">
                     <li class="nav-item dropdown">
@@ -159,6 +157,8 @@
                             <li><a class="dropdown-item" href="complex-example.html" title="Complex Example">Complex Example</a></li>
                             <li><a class="dropdown-item" href="execute-commands-example.html" title="Execute Commands Example">Execute Commands Example</a></li>
                             <li><a class="dropdown-item" href="run-example.html" title="Run Example">Run Example</a></li>
+                            <li><a class="dropdown-item" href="package-example.html" title="Package Example">Package Example</a></li>
+                            <li><a class="dropdown-item" href="provision-example.html" title="Provision Example">Provision Example</a></li>
                         </ul>
                     </li>
                     <li class="nav-item dropdown">
@@ -182,9 +182,9 @@
 </header>
 <section id="main-section" class="container flex-grow-1">
 <section> 
- <h2 id="wildflyadd-resource">wildfly:add-resource</h2> 
+ <h2 id="wildflyadd-resource"><a name="wildfly:add-resource"></a>wildfly:add-resource</h2> 
  <p><b>Full name</b>:</p> 
- <p>org.wildfly.plugins:wildfly-maven-plugin:2.1.0.Final:add-resource</p> 
+ <p>org.wildfly.plugins:wildfly-maven-plugin:3.0.0.Beta1:add-resource</p> 
  <p><b>Description</b>:</p> 
  <div>
   Adds a resource If force is set to false and the resource has already been added to the server, an error will occur and the operation will fail. 
@@ -194,7 +194,7 @@ <h2 id="wildflyadd-resource">wildfly:add-resource</h2>
   <li>Requires a Maven project to be executed.</li> 
  </ul> 
  <section> 
-  <h3 id="optional-parameters">Optional Parameters</h3> 
+  <h3 id="optional-parameters"><a name="Optional_Parameters"></a>Optional Parameters</h3> 
   <table class="table table-striped table-bordered">
    <thead>
     <tr> 
@@ -293,8 +293,8 @@ <h3 id="optional-parameters">Optional Parameters</h3>
   </table> 
  </section> 
  <section> 
-  <h3 id="parameter-details">Parameter Details</h3> 
-  <p><b>address:</b></p> 
+  <h3 id="parameter-details"><a name="Parameter_Details"></a>Parameter Details</h3> 
+  <p><b><a name="address">address</a>:</b></p> 
   <div>
    The operation address, as a comma separated string. If the resource or resources also define and address, this address will be used as the parent address. Meaning the resource addresses will be prepended with this address.
   </div> 
@@ -303,7 +303,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Required</b>: No</li> 
   </ul>
   <hr> 
-  <p><b>authenticationConfig:</b></p> 
+  <p><b><a name="authenticationConfig">authenticationConfig</a>:</b></p> 
   <div>
    A URL which points to the authentication configuration (wildfly-config.xml) the client uses to authenticate with the server.
   </div> 
@@ -314,7 +314,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Alias</b>: authentication-config</li> 
   </ul>
   <hr> 
-  <p><b>force:</b></p> 
+  <p><b><a name="force">force</a>:</b></p> 
   <div>
    Specifies whether force mode should be used or not. 
    <br> 
@@ -327,7 +327,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Default</b>: true</li> 
   </ul>
   <hr> 
-  <p><b>hostname:</b></p> 
+  <p><b><a name="hostname">hostname</a>:</b></p> 
   <div>
    Specifies the host name of the server where the deployment plan should be executed.
   </div> 
@@ -338,7 +338,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Default</b>: localhost</li> 
   </ul>
   <hr> 
-  <p><b>id:</b></p> 
+  <p><b><a name="id">id</a>:</b></p> 
   <div>
    Specifies the id of the server if the username and password is to be retrieved from the settings.xml file
   </div> 
@@ -348,7 +348,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>User Property</b>: wildfly.id</li> 
   </ul>
   <hr> 
-  <p><b>jbossHome:</b></p> 
+  <p><b><a name="jbossHome">jbossHome</a>:</b></p> 
   <div>
    The WildFly Application Server's home directory. This is not required, but should be used for commands such as module add as they are executed on the local file system.
   </div> 
@@ -359,7 +359,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Alias</b>: jboss-home</li> 
   </ul>
   <hr> 
-  <p><b>password:</b></p> 
+  <p><b><a name="password">password</a>:</b></p> 
   <div>
    Specifies the password to use if prompted to authenticate by the server. If no password is specified and the server requests authentication the user will be prompted to supply the password,
   </div> 
@@ -369,7 +369,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>User Property</b>: wildfly.password</li> 
   </ul>
   <hr> 
-  <p><b>port:</b></p> 
+  <p><b><a name="port">port</a>:</b></p> 
   <div>
    Specifies the port number the server is listening on.
   </div> 
@@ -380,7 +380,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Default</b>: 9990</li> 
   </ul>
   <hr> 
-  <p><b>profiles:</b></p> 
+  <p><b><a name="profiles">profiles</a>:</b></p> 
   <div>
    The profiles where resources should be added to.
   </div> 
@@ -390,7 +390,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>User Property</b>: wildfly.profiles</li> 
   </ul>
   <hr> 
-  <p><b>protocol:</b></p> 
+  <p><b><a name="protocol">protocol</a>:</b></p> 
   <div>
    The protocol used to connect to the server for management.
   </div> 
@@ -400,7 +400,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>User Property</b>: wildfly.protocol</li> 
   </ul>
   <hr> 
-  <p><b>resources:</b></p> 
+  <p><b><a name="resources">resources</a>:</b></p> 
   <div>
    A collection of resources to add.
   </div> 
@@ -409,7 +409,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Required</b>: No</li> 
   </ul>
   <hr> 
-  <p><b>skip:</b></p> 
+  <p><b><a name="skip">skip</a>:</b></p> 
   <div>
    Set to true if you want this goal to be skipped, otherwise false.
   </div> 
@@ -420,7 +420,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Default</b>: false</li> 
   </ul>
   <hr> 
-  <p><b>timeout:</b></p> 
+  <p><b><a name="timeout">timeout</a>:</b></p> 
   <div>
    The timeout, in seconds, to wait for a management connection.
   </div> 
@@ -431,7 +431,7 @@ <h3 id="parameter-details">Parameter Details</h3>
    <li><b>Default</b>: 60</li> 
   </ul>
   <hr> 
-  <p><b>username:</b></p> 
+  <p><b><a name="username">username</a>:</b></p> 
   <div>
    Specifies the username to use if prompted to authenticate by the server. If no username is specified and the server requests authentication the user will be prompted to supply the username,
   </div> 
@@ -448,12 +448,12 @@ <h3 id="parameter-details">Parameter Details</h3>
     </div>
     <div id="footer-info" class="bg-bg-primary ps-2 pb-1 w-100">
         <div id="footer-custom-content"><div class="float-md-end"><a href="http://www.redhat.com/"><span class="fw-bold btn-link">Sponsored by</span> <img class="img-fluid" src="https://www.wildfly.org/assets/img/redhat_reversed.svg"></a></div></div>
-        <div> <span class="far fa-copyright"></span>2021
+        <div> <span class="far fa-copyright"></span>2022
 <a href="http://www.jboss.org">JBoss by Red Hat</a>
 -
 <a href="http://repository.jboss.org/licenses/lgpl-2.1.txt">GNU Lesser General Public License v2.1 only</a> 
 </div>
-        <div>Rendered using <a href="https://github.com/Bernardo-MG/docs-maven-skin">Docs Maven Skin</a> 2.2.4</div>
+        <div>Rendered using <a href="https://github.com/Bernardo-MG/docs-maven-skin">Docs Maven Skin</a> 2.2.5</div>
     </div>
 </footer>
 <script src="./lib/bootstrap/dist/js/bootstrap.min.js"></script>