svn commit: r1561353 - in /maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt: examples/multi-module-configuration.apt.vm examples/one-module-configuration.apt.vm usage.apt.vm various-tips.apt.vm

[hb...@apache.org]

Author: hboutemy
Date: Sat Jan 25 18:07:08 2014
New Revision: 1561353

URL: http://svn.apache.org/r1561353
Log:
improved doc

Modified:
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/usage.apt.vm
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm

Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm?rev=1561353&r1=1561352&r2=1561353&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm (original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/multi-module-configuration.apt.vm Sat Jan 25 18:07:08 2014
@@ -29,33 +29,14 @@
 
 Maven Multi Module Configuration
 
-  With a multi modules build, you cannot use: <<<mvn site-deploy>>>. You must stage your site first.
+  With a multi modules build, you cannot simply use <<<mvn site-deploy>>>: you must stage your site first.
 
-  Cli command to use: <<<mvn -Preporting site site:stage>>> then <<<mvn scm-publish:publish-scm>>>
-
-+-----------------------
-
-  <properties>
-    <!-- override the property in your settings -->
-    <site.mainDirectory>${user.home}</site.mainDirectory>
-    // it's a default location for performance reason (avoid checkout the content on every build)
-    // you can override this value in your settings.
-    <scmCheckout.path>${site.mainDirectory}/$\{project.artifactId}</scmCheckout.path>
-  </properties>
-
-  <plugin>
-    <groupId>org.apache.maven.plugins</groupId>
-    <artifactId>maven-scm-publish-plugin</artifactId>
-    <version>${project.version}</version>
-    <configuration>
-      <checkoutDirectory>${scmCheckout.path}</checkoutDirectory>
-    </configuration>
-  </plugin>
-  <plugin>
-    <groupId>org.apache.maven.plugins</groupId>
-    <artifactId>maven-site-plugin</artifactId>
-  </plugin>
-
-+-----------------------
+  Cli commands to use:
 
++------------+
+mvn -Preporting site site:stage
+mvn scm-publish:publish-scm
++------------+
 
+  These commands work well with mono-module too, even if mono-module could permit some optimizations (everything can be run
+  in only one Maven invocation).

Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm?rev=1561353&r1=1561352&r2=1561353&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm (original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/one-module-configuration.apt.vm Sat Jan 25 18:07:08 2014
@@ -29,9 +29,9 @@
 
 Maven Mono Module Configuration
 
-  <<This easy configuration works only for mono module maven build>>
+  <<This easy to use and optimized (no staging) configuration works only for mono module Maven build>>
 
-  With this configuration you can simply run: <<<mvn site-deploy>>>
+  With following configuration you can simply run: <<<mvn site-deploy>>>
 
 +-----------------------
     <plugin>
@@ -46,7 +46,7 @@ Maven Mono Module Configuration
       <artifactId>maven-scm-publish-plugin</artifactId>
       <version>${project.version}</version>
       <configuration>
-        <content>${project.reporting.outputDirectory}</content>
+        <content>${project.reporting.outputDirectory}</content><!-- mono-module doesn't require site:stage -->
       </configuration>
       <executions>
         <execution>
@@ -59,5 +59,3 @@ Maven Mono Module Configuration
       </executions>
     </plugin>
 +-----------------------
-
-

Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/usage.apt.vm?rev=1561353&r1=1561352&r2=1561353&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/usage.apt.vm Sat Jan 25 18:07:08 2014
@@ -44,24 +44,24 @@ mvn scm-publish:publish-scm
 
  There are two ways you can set this up for site in your POM.
 
-  * Use the Custom Lifecycle
+** Use the Custom Lifecycle
 
   Unfortunately, a Maven plugin can't define a top-level lifecycle
   like 'site'. However, it can come close. The plugin includes the 
   <scmpublish> goal. This goal does nothing except fork a custom
   <scmpublish> lifecycle, consisting of the following phases:
 
-    ** <<<scmpublish-prepare>>>
+  * <<<scmpublish-prepare>>>
 
-    ** <<<scmpublish-pre-site>>>
+  * <<<scmpublish-pre-site>>>
 
-    ** <<<scmpublish-site>>>
+  * <<<scmpublish-site>>>
 
-    ** <<<scmpublish-post-site>>>
+  * <<<scmpublish-post-site>>>
 
-    ** <<<scmpublish-publish>>>
+  * <<<scmpublish-publish>>>
 
-    []
+  []
 
   (Again unfortunately, Maven does not allow a custom lifecycle to share
   phases with some other lifecycle.)
@@ -96,7 +96,7 @@ mvn scm-publish:publish-scm
   <Notice>: this is actually not working, the 003-lifecycle IT has been disabled.
 
 
-  * Using the Site Lifecycle
+** Using the Site Lifecycle
 
    The alternative is to attach the necessary activities to the site lifecycle and deactivate
    maven-site-plugin's site deploy goal. This requires more XML in the POM, but it may be easier

Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm?rev=1561353&r1=1561352&r2=1561353&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm (original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/various-tips.apt.vm Sat Jan 25 18:07:08 2014
@@ -53,7 +53,7 @@ Various tips for using this plugin
 
 * Git branch
 
-  To use git branch (by example: github gh-pages)
+  To use git branch (for example: github gh-pages)
 
 +----------------
   <distributionManagement>
@@ -74,7 +74,7 @@ Various tips for using this plugin
 +----------------
 
 
-* Some Tips to improve performance
+* Improving SCM Checkout Performance
 
   By default, a complete checkout is done. You can configure the plugin to try update rather than a full checkout/clone