svn commit: r855713 - in /websites/staging/commons/trunk/content: ./ site-publish.html

[bu...@apache.org]

Author: buildbot
Date: Sat Mar 23 20:31:22 2013
New Revision: 855713

Log:
Staging update by buildbot for commons

Modified:
    websites/staging/commons/trunk/content/   (props changed)
    websites/staging/commons/trunk/content/site-publish.html

Propchange: websites/staging/commons/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sat Mar 23 20:31:22 2013
@@ -1 +1 @@
-1460220
+1460226

Modified: websites/staging/commons/trunk/content/site-publish.html
==============================================================================
--- websites/staging/commons/trunk/content/site-publish.html (original)
+++ websites/staging/commons/trunk/content/site-publish.html Sat Mar 23 20:31:22 2013
@@ -168,47 +168,48 @@
  
   <div class="section"><h2>Introduction<a name="Introduction"></a></h2>
     <p>
-    Due to svnpubsub migration, procedure to publish sites has been changed.
-    Commons sites use a solution based on both <a class="externalLink" href="http://apache.org/dev/cmsref.html">Apache cms</a> (for main site)
-     and svnpubsub publication based on <a class="externalLink" href="http://maven.apache.org/plugins/maven-scm-publish-plugin/">maven-scm-publish-plugin</a>.
+    Due to svnpubsub migration, the procedure to publish sites has been changed.
+    Commons sites use a solution based on both <a class="externalLink" href="http://apache.org/dev/cmsref.html">Apache CMS</a> (for the main site)
+     and svnpubsub publication based on the <a class="externalLink" href="http://maven.apache.org/plugins/maven-scm-publish-plugin/">maven-scm-publish-plugin</a>
+      for the component sites.
     </p>
 
   </div>
   <div class="section"><h2>Main site<a name="Main_site"></a></h2>
-    <p>Apache CMS UI can be used to modify and publish main web site: <a class="externalLink" href="https://cms.apache.org/commons/">https://cms.apache.org/commons/</a>.
+    <p>The Apache CMS UI can be used to modify and publish main web site: <a class="externalLink" href="https://cms.apache.org/commons/">https://cms.apache.org/commons/</a>.
       More documentation is available <a class="externalLink" href="http://apache.org/dev/cmsref.html">here</a>
 
     </p>
     <p>
       The main site content is now located in svn: https://svn.apache.org/repos/asf/commons/cms-site/trunk/ .<br />
-      You can test your change locally using: 
+      You can test your changes locally using: 
       </p><div><pre>mvn clean site</pre></div>
     
   </div>
   <div class="section"><h2>Components<a name="Components"></a></h2>
     <p>
-      Components use maven-scm-publish-plugin. The maven generated site is checkin to:
+      Components use the maven-scm-publish-plugin. The maven generated site is checked in to:
       </p><ul>
-        <li>propers: https://svn.apache.org/repos/infra/websites/production/commons/content/proper/</li>
+        <li>proper: https://svn.apache.org/repos/infra/websites/production/commons/content/proper/</li>
         <li>sandbox: https://svn.apache.org/repos/infra/websites/production/commons/content/sandbox/</li>
         <li>dormant: https://svn.apache.org/repos/infra/websites/production/commons/content/dormant/</li>
       </ul>
     
     <p>
-      Components need to use parent 28 (sandbox parent: 10).
+      Components must use parent 28 (sandbox parent: 10) or later.
     </p>
-    <div class="section"><h3>Publishing single module projects<a name="Publishing_single_module_projects"></a></h3>
-      <p>
-        Simply using:
-        <tt>mvn clean site-deploy</tt>
-      </p>
-    </div>
-    <div class="section"><h3>Publishing multi modules projects<a name="Publishing_multi_modules_projects"></a></h3>
-      <p>
-        Simply using:
-        <tt>clean site site:stage scm-publish:publish-scm</tt>
-      </p>
-    </div>
+    <p>Maven will create a working copy of the site svn directory (<tt>~/commons-sites/</tt>
+      by default) publish your site to it and commit the changes.  It will not prompt you for your svn
+      password so the commit will fail unless subversion is configured to store your password.  If it
+      fails, you can commit the changes manually.</p>
+    <p>In order to publish the site of a single module project use</p>
+    <div><pre>
+      mvn clean site-deploy
+    </pre></div>
+    <p>and for a multi modules project use</p>
+    <div><pre>
+      mvn clean site site:stage scm-publish:publish-scm
+    </pre></div>
     <div class="section"><h3>Configuration<a name="Configuration"></a></h3>
       <p>
         Default deployment targets are:
@@ -219,9 +220,9 @@
         </ul>
       
       <p>
-        maven-scm-publish-plugin will delete content not generated by Maven site plugin.
-        To avoid delete of previous apis javadocs, the pom need some configuration:
-        </p><div><pre>
+        The maven-scm-publish-plugin will delete any content not generated by the Maven site plugin.
+        To avoid deletion of previous apis javadocs or other static content, the pom needs some configuration:</p>
+        <div><pre>
           
           &lt;plugin&gt;
             &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
@@ -235,11 +236,7 @@
           &lt;/plugin&gt;
           
         </pre></div>
-        All paths declared won't be deleted from svn
-      
-      <p>
-        <b>NOTE:</b> this old content need to be imported manually.
-      </p>
+        <p>All declared paths won't be deleted from svn but rather have to be imported manually.</p>
     </div>
   </div>