Author: olamy
Date: Wed Jan 2 11:21:33 2013
New Revision: 1427746
URL: http://svn.apache.org/viewvc?rev=1427746&view=rev
Log:
Apache Archiva Main site deployment
Modified:
archiva/site-content/developers/publishing-site.html
Modified: archiva/site-content/developers/publishing-site.html
URL:
http://svn.apache.org/viewvc/archiva/site-content/developers/publishing-site.html?rev=1427746&r1=1427745&r2=1427746&view=diff
==============================================================================
--- archiva/site-content/developers/publishing-site.html (original)
+++ archiva/site-content/developers/publishing-site.html Wed Jan 2 11:21:33
2013
@@ -215,7 +215,11 @@ pageTracker._trackPageview();</script>
<div class="section"><h2>Publishing the Archiva Site<a
name="Publishing_the_Archiva_Site"></a></h2><p>The Archiva site, documentation
and reference documentation are now published to
<tt>http://archiva.apache.org/</tt> using the <a class="externalLink"
href="http://www.apache.org/dev/project-site.html#svnpubsub";> ASF's
svnpubsub</a> service.</p><p>The files published to the site are all stored
under the Subversion repository at <a class="externalLink"
href="http://svn.apache.org/repos/asf/archiva/site-content/";>http://svn.apache.org/repos/asf/archiva/site-content/</a>.</p><p>This
mostly operates like a normal site deployment, though there are some specific
customisations and special instructions for the reference library. The
processes follow those described for the <a class="externalLink"
href="http://maven.apache.org/plugins/maven-scm-publish-plugin/";>Maven SCM
Publish Plugin</a> for <a class="externalLink"
href="http://maven.apache.org/plugins/maven-scm-publis
h-plugin/examples/one-module-configuration.html"> Single module projects</a>
and <a class="externalLink"
href="http://maven.apache.org/plugins/maven-scm-publish-plugin/examples/multi-module-configuration.html";>
Multi-module projects</a> as applicable.</p><p>Each site checks out the
production site data into the <tt>site-publish</tt> directory of the current
project, to avoid being cleaned as part of the build. It is ignored by
<tt>svn</tt> operations, but you should ensure that the checkout is clean if
you ever cancel or have a failure during a publish operation. You can check it
is clean by ensuring there is no data from <tt>svn status</tt> in that
directory, or by removing it and having it get checked out again.</p><div
class="section"><h3>Editing and Publishing the Main Site<a
name="Editing_and_Publishing_the_Main_Site"></a></h3><p>The site displayed at
the root of <a class="externalLink"
href="http://archiva.apache.org";>http://archiva.apache.org</a> (where you are
readin
g this) has its source code in Subversion at <a class="externalLink"
href="https://svn.apache.org/repos/asf/archiva/site";>https://svn.apache.org/repos/asf/archiva/site</a>.</p><p>To
edit and publish the site, do the following:</p><ol style="list-style-type:
decimal"><li>Checkout the source code from Subversion (if you follow the
instructions in <a href="./building.html"> Building Archiva</a>, you will
already have it.</li><li>Make edits and check them using <tt>mvn site</tt> or
<tt>mvn site:run</tt> until satisfied.</li><li>Commit your changes (making sure
your working copy is completely up to date first)</li><li>Publish the
site:<div><pre>mvn site-deploy</pre></div></li></ol><p>This site deployment can
be done at any time, and is not tied to releases.</p><p>Note that since the
main site also contains the (large!) <tt>docs</tt> and <tt>ref</tt> directories
in the <tt>site-publish</tt> directory, there is a special
<tt>setup-checkout</tt> profile in place to get the initial c
heckout without those directories. This will normally be activated whenever
the <tt>site-publish</tt> directory is missing - if you happen to have active
profiles from your <tt>settings.xml</tt> you may need to enable it explicitly
whenever you do a deployment and that checkout is missing: <tt>mvn site-deploy
-Psetup-checkout</tt> </p></div><div class="section"><h3>Editing and Publishing
the Archiva Documentation<a
name="Editing_and_Publishing_the_Archiva_Documentation"></a></h3><p>The
documentation displayed under the subdirectories of <a class="externalLink"
href="http://archiva.apache.org/docs/";>http://archiva.apache.org/docs/</a> has
its source code in Subversion at <a class="externalLink"
href="https://svn.apache.org/repos/asf/archiva/trunk/archiva-docs";>https://svn.apache.org/repos/asf/archiva/trunk/archiva-docs</a>,
which is part of the main project checkout.</p><p>The instructions for
managing the documentation is the same as for the main site, being published
from t
he directory using:</p><div><pre>mvn site-deploy</pre></div><p>However, in
this case it is typically done as part of a release process - see <a
href="./releasing.html"> Releasing Archiva</a> for instructions on doing
this.</p><p>The documentation remains versioned based on the release it is
related to. To best manage this with svnpubsub, the site is always published
into a directory <tt>docs/latest</tt>, only requiring a small number of
modifications to be made. Then, as part of the release instructions, the
<tt>latest</tt> directory is copied to the versioned location - for example,
<tt>http://svn.apache.org/repos/asf/archiva/site-content/docs/1.4-M4</tt>.</p><p>For
<tt>site:stage</tt> to apply correctly without needing a full checkout, a
workaround is applied by setting the <tt>distributionManagement/site/url</tt>
element to match that of the parent site. The value is then overridden with the
correct value in the <tt>maven-scm-publish-plugin</tt> configuration. This
avoids
the Site plugin attempting to relativize links incorrectly.</p></div><div
class="section"><h3>Editing and Publishing the Reference Documentation<a
name="Editing_and_Publishing_the_Reference_Documentation"></a></h3><p>The
reference documentation, including JavaDocs and source cross-reference, is
displayed under the URL <a class="externalLink"
href="http://archiva.apache.org/ref";>http://archiva.apache.org/ref</a>. At this
time, only the latest reference documents are retained. They require quite a
lot of space, and historical information is of less relevance to Archiva
developers or users.</p><p>To publish the latest reference documents, you need
to run:</p><div><pre>cd archiva-modules
mvn site site:stage scm-publish:publish-scm
or
-sh ./deploySite.sh</pre></div><p>This will likely cause a very large commit,
and should be done infrequently. Once per release is likely to be
adequate.</p></div></div>
+sh ./deploySite.sh</pre></div><p>This will likely cause a very large commit,
and should be done infrequently. Once per release is likely to be
adequate.</p></div><div class="section"><h3>Publishing Redback site<a
name="Publishing_Redback_site"></a></h3><p>The redback is stored under the
Subversion repository at <a class="externalLink"
href="https://svn.apache.org/repos/asf/archiva/redback/redback-site/trunk";>https://svn.apache.org/repos/asf/archiva/redback/redback-site/trunk</a>.</p><p>It's
displayed under the URL <a class="externalLink"
href="http://archiva.apache.org/redback";>http://archiva.apache.org/redback</a>.</p><p>To
publish documentation, you need to run:</p><div><pre>mvn
site-deploy</pre></div></div><div class="section"><h3>Publishing Redback Core
reference<a name="Publishing_Redback_Core_reference"></a></h3><p>The Redback
core reference is displayed under the URL <a class="externalLink"
href="http://archiva.apache.org/redback/core";>http://archiva.apache.org/redbac
k/core</a>.</p><p>It contains javadoc for Redback core.</p><p>To publish
documentation, you need to run:</p><div><pre>mvn clean site-deploy
scm-publish:publish-scm
+or
+sh ./deploySite.sh</pre></div></div><div class="section"><h3>Publishing
Redback Components reference<a
name="Publishing_Redback_Components_reference"></a></h3><p>The Redback
components reference is displayed under the URL <a class="externalLink"
href="http://archiva.apache.org/redback/components";>http://archiva.apache.org/redback/components</a>.</p><p>It
contains javadoc for Redback components.</p><p>To publish documentation, you
need to run:</p><div><pre>mvn clean site-deploy scm-publish:publish-scm
+or
+sh ./deploySite.sh</pre></div></div></div>
</div>
</div>
