You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2014/05/18 22:31:08 UTC

svn commit: r1595674 - in /maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt: examples/importing-maven-site.apt index.apt.vm various-tips.apt.vm

Author: hboutemy
Date: Sun May 18 20:31:07 2014
New Revision: 1595674

URL: http://svn.apache.org/r1595674
Log:
misc enhancements

Modified:
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/importing-maven-site.apt
    maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.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/importing-maven-site.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/importing-maven-site.apt?rev=1595674&r1=1595673&r2=1595674&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/importing-maven-site.apt (original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/examples/importing-maven-site.apt Sun May 18 20:31:07 2014
@@ -39,7 +39,7 @@ Importing maven.apache.org Content to Sv
 +--------
 # configuration
 ORIG_PATH=/www/maven.apache.org
-DEST_SVN_BASE=https://svn.apache.org/repos/infra/websites/production/maventest/content
+DEST_SVN_BASE=https://svn.apache.org/repos/infra/websites/production/maven/content
 
 ARTIFACT=maven-clean-plugin
 DIR=plugins/${ARTIFACT}

Modified: maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm?rev=1595674&r1=1595673&r2=1595674&view=diff
==============================================================================
--- maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm (original)
+++ maven/plugins/trunk/maven-scm-publish-plugin/src/site/apt/index.apt.vm Sun May 18 20:31:07 2014
@@ -31,13 +31,13 @@ ${project.name}
     The maven-scm-publish-plugin is a utility plugin to allow publishing Maven
     website to any supported SCM.
     The primary goal was to have an utility plugin to allow Apache projects
-    to publish Maven websites via the ASF svnpubsub system
+    to publish Maven websites via the ASF svnpubsub system.
 
     In addition to SCM operations, it takes care to fix newline inconsistencies
     generated by <<<maven-site-plugin>>> (see {{{https://jira.codehaus.org/browse/MSITE-121}MSITE-121}}),
     which prevents simple content import to SCM.
 
-    The plugin has been tested with git scm too and by example can push content for github pages too.
+    The plugin has been tested with git scm too and by example can push content for github pages.
 
 
 * Implementation
@@ -50,7 +50,7 @@ ${project.name}
 
     Then locally staged content is applied to the check-out, issuing
     appropriate SCM commands to add and delete entries, followed by a
-    checkin.
+    check-in.
 
     The <<scmpublish.dryRun>> parameter to the plugin avoids all
     SCM operations, and simply logs out the added, deleted,
@@ -62,11 +62,11 @@ ${project.name}
 
 * Publishing any content to SCM
 
-    Even without any pom.xml/Maven project, you can update SCM content with
+    Even without any <<<pom.xml>>>/Maven project, you can update SCM content with
     a local content:
 
 +-------+
-mvn scm-publish:publish-scm -Dscmpublish.pubScmUrl=scm:... -Dscmpublish.content=...path-to-content...
+mvn scm-publish:publish-scm -Dscmpublish.pubScmUrl=scm:<scm-provider>... -Dscmpublish.content=...path-to-content...
 +-------+
 
     SCM content will be checked-out to a temporary directory, then local content will
@@ -81,8 +81,8 @@ mvn scm-publish:publish-scm -Dscmpublish
 
     There are 2 known limitations:
     
-    * For svn the plugin can create the initial SCM directory if it does not exist. But for git by example if you use a branch,
-    the branch won't be created, you have to create it manually.
+    * for svn, the plugin can create the initial SCM directory if it does not exist. But for git by example, if you use a branch,
+    the branch won't be created: you have to create it manually,
 
     * the plugin works well for multi-module websites publishing to a complete directory:
     you just need to publish <<<mvn site:stage>>> content. But if one module does not publish
@@ -99,7 +99,7 @@ mvn scm-publish:publish-scm -Dscmpublish
 
     To reach such a dream, there are some steps:
 
-    * fix inconsistent newlines generated by <<<maven-site-plugin>>> (caused by site.vm template and
+    * fix inconsistent newlines generated by <<<maven-site-plugin>>> (caused by <<<site.vm>>> template and
       resources taken from skin jar without fixing newlines): {{{https://jira.codehaus.org/browse/MSITE-121}MSITE-121}}
       is fixed in (future) maven-site-plugin 3.4,
 
@@ -108,4 +108,4 @@ mvn scm-publish:publish-scm -Dscmpublish
 
     []
 
-    Then this plugin will be outdated, replaced by natural <<<maven-site-plugin:deploy>>> goal.
+    Then this plugin would be outdated, replaced by natural <<<maven-site-plugin:deploy>>> goal.

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=1595674&r1=1595673&r2=1595674&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 Sun May 18 20:31:07 2014
@@ -36,7 +36,7 @@ Various tips for using this plugin
   scm:<scm_provider><delimiter><provider_specific_part>
 +----------------
 
-  Example for svn: <<<scm:svn:https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-scm-publish-plugin/>>>
+  Example for svn: <<<scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin/>>>
 
   And configure is as it:
 
@@ -44,7 +44,7 @@ Various tips for using this plugin
   <distributionManagement>
     <site>
       <id>site_id</id>
-      <url>scm:svn:https://svn.apache.org/repos/infra/websites/production/maventest/content/plugins/maven-scm-publish-plugin/</url>
+      <url>scm:svn:https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin/</url>
     </site>
   </distributionManagement>
 +----------------