You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2013/03/23 21:31:11 UTC
svn commit: r1460226 - /commons/cms-site/trunk/content/xdoc/site-publish.xml
Author: bodewig
Date: Sat Mar 23 20:31:10 2013
New Revision: 1460226
URL: http://svn.apache.org/r1460226
Log:
cosmetics
Modified:
commons/cms-site/trunk/content/xdoc/site-publish.xml
Modified: commons/cms-site/trunk/content/xdoc/site-publish.xml
URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/site-publish.xml?rev=1460226&r1=1460225&r2=1460226&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/site-publish.xml (original)
+++ commons/cms-site/trunk/content/xdoc/site-publish.xml Sat Mar 23 20:31:10 2013
@@ -26,47 +26,48 @@
<body>
<section name='Introduction'>
<p>
- Due to svnpubsub migration, procedure to publish sites has been changed.
- Commons sites use a solution based on both <a href="http://apache.org/dev/cmsref.html">Apache cms</a> (for main site)
- and svnpubsub publication based on <a 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 href="http://apache.org/dev/cmsref.html">Apache CMS</a> (for the main site)
+ and svnpubsub publication based on the <a href="http://maven.apache.org/plugins/maven-scm-publish-plugin/">maven-scm-publish-plugin</a>
+ for the component sites.
</p>
</section>
<section name="Main site">
- <p>Apache CMS UI can be used to modify and publish main web site: <a 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 href="https://cms.apache.org/commons/">https://cms.apache.org/commons/</a>.
More documentation is available <a 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:
<pre>mvn clean site</pre>
</p>
</section>
<section name="Components">
<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:
<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>
<p>
- Components need to use parent 28 (sandbox parent: 10).
+ Components must use parent 28 (sandbox parent: 10) or later.
</p>
- <subsection name="Publishing single module projects">
- <p>
- Simply using:
- <code>mvn clean site-deploy</code>
- </p>
- </subsection>
- <subsection name="Publishing multi modules projects">
- <p>
- Simply using:
- <code>clean site site:stage scm-publish:publish-scm</code>
- </p>
- </subsection>
+ <p>Maven will create a working copy of the site svn directory (<code>~/commons-sites/</code>
+ 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>
+ <pre>
+ mvn clean site-deploy
+ </pre>
+ <p>and for a multi modules project use</p>
+ <pre>
+ mvn clean site site:stage scm-publish:publish-scm
+ </pre>
<subsection name="Configuration">
<p>
Default deployment targets are:
@@ -77,8 +78,8 @@
</ul>
</p>
<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:
+ 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>
<pre>
<![CDATA[
<plugin>
@@ -93,11 +94,7 @@
</plugin>
]]>
</pre>
- All paths declared won't be deleted from svn
- </p>
- <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>
</subsection>
</section>