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

[ol...@apache.org]

Author: olamy
Date: Tue Sep  4 20:14:51 2012
New Revision: 1380848

URL: http://svn.apache.org/viewvc?rev=1380848&view=rev
Log:
fix doc properties

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/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=1380848&r1=1380847&r2=1380848&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 Tue Sep  4 20:14:51 2012
@@ -35,9 +35,9 @@ Maven Multi Module Configuration
 +-----------------------
 
   <properties>
-    <siteContentPath>${user.home}/my-site-deploy</siteContentPath>
-    <scmCheckoutPath>${user.home}/my-site-content</scmCheckoutPath>
-    <siteDeployUrl>file://${siteContentPath}</siteDeployUrl>
+    <siteContent.path>${user.home}/my-site-deploy</siteContent.path>
+    <scmCheckout.path>${user.home}/my-site-content</scmCheckout.path>
+    <siteDeploy.url>file://${siteContent.path}</siteDeploy.url>
   </properties>
 
   <plugin>
@@ -45,8 +45,8 @@ Maven Multi Module Configuration
     <artifactId>maven-scm-publish-plugin</artifactId>
     <version>${project.version}</version>
     <configuration>
-      <checkoutDirectory>$\{scmCheckoutPath}</checkoutDirectory>
-      <content>$\{siteContentPath}</content>
+      <checkoutDirectory>${scmCheckout.path}</checkoutDirectory>
+      <content>${siteContent.path}</content>
     </configuration>
   </plugin>
   <plugin>
@@ -54,7 +54,7 @@ Maven Multi Module Configuration
     <artifactId>maven-site-plugin</artifactId>
     <version>3.1</version>
     <configuration>
-      <stagingSiteURL>$\{siteDeployUrl}</stagingSiteURL>
+      <stagingSiteURL>${siteDeploy.url}</stagingSiteURL>
     </configuration>
   </plugin>
 

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=1380848&r1=1380847&r2=1380848&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 Tue Sep  4 20:14:51 2012
@@ -28,6 +28,49 @@
 
 Various tips for using this plugin
 
+* URLS format
+
+  You must a scm url format:
++----------------
+  scm:<scm_provider><delimiter><provider_specific_part>
++----------------
+
+  Svn example: scm:svn:https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-scm-publish-plugin/
+
+  And configure is as it:
+
++----------------
+
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-scm-publish-plugin</artifactId>
+      <version>${project.version}</version>
+      <configuration>
+        <pubScmUrl>scmUrl</pubScmUrl>
+      </configuration>
+    </plugin>
+
++----------------
+
+  <<<NOTE>>>: with the svn if the remote url doesn't exist it will be created.
+
+  To use git branch (by example: github gh-pages)
+
++----------------
+
+    <plugin>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-scm-publish-plugin</artifactId>
+      <version>${project.version}</version>
+      <configuration>
+        <scmBranch>gh-pages</scmBranch>
+        <pubScmUrl>scm:git:git@github.com:olamy/tomcat-foo-artifact.git</pubScmUrl>
+      </configuration>
+    </plugin>
+
++----------------
+
+
 * Some Tips to improve performance
 
   By default, a complete checkout is done, you can configure the plugin to try update rather than a full checkout/clone