[jboss-svn-commits] JBL Code SVN: r14495 - labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt.

[jboss-svn-commits at lists.jboss.org]

Author: pgier
Date: 2007-08-23 14:33:29 -0400 (Thu, 23 Aug 2007)
New Revision: 14495

Modified:
   labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/index.apt
Log:
Adding a bit of documentation.

Modified: labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/index.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/index.apt	2007-08-23 18:09:06 UTC (rev 14494)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jboss-deploy-plugin/src/site/apt/index.apt	2007-08-23 18:33:29 UTC (rev 14495)
@@ -34,4 +34,26 @@
 
 * Usage
 
-    Detailed usage instructions for the <jboss-deploy Plugin> can be found {{{usage.html}here}}.
+* Minimal configuration
+
+    The most basic configuration of the plugin is to simply tell the plugin
+    the default goal to execute and where to deploy artifacts:
+
++----+
+      <plugin>
+        <groupId>org.jboss.maven.plugins</groupId>
+        <artifactId>maven-jboss-deploy-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>jboss-deploy</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <jbossDeployRoot>file:///path/to/deploy</jbossDeployRoot>
+        </configuration>
+      </plugin>
++----+
+
+    Additional information and examples can be found {{{usage.html}here}}.