You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by bu...@apache.org on 2013/08/08 15:40:49 UTC
svn commit: r873497 - in /websites/staging/directory/trunk/content: ./
mavibot/developer-guide.html
Author: buildbot
Date: Thu Aug 8 13:40:48 2013
New Revision: 873497
Log:
Staging update by buildbot for directory
Modified:
websites/staging/directory/trunk/content/ (props changed)
websites/staging/directory/trunk/content/mavibot/developer-guide.html
Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Aug 8 13:40:48 2013
@@ -1 +1 @@
-1511775
+1511776
Modified: websites/staging/directory/trunk/content/mavibot/developer-guide.html
==============================================================================
--- websites/staging/directory/trunk/content/mavibot/developer-guide.html (original)
+++ websites/staging/directory/trunk/content/mavibot/developer-guide.html Thu Aug 8 13:40:48 2013
@@ -362,71 +362,107 @@ Emmanuel
<h2 id="release">Release</h2>
<p>If the vote succeeds the Mavibot project can be released.</p>
-<p>Go to https://repository.apache.org/index.html#stagingRepositories and release the staging repository so all artifacts are published to Maven central.</p>
-<p>Move the distribution packages (sources and binaries) to the dist SVN repository: https://dist.apache.org/repos/dist/release/directory/mavibot/dist/$(version)</p>
+<p>Go to <a href="https://repository.apache.org/index.html#stagingRepositories">https://repository.apache.org/index.html#stagingRepositories</a> and release the staging repository so all artifacts are published to Maven central.</p>
+<p>Move the distribution packages (sources and binaries) to the dist SVN repository: </p>
+<div class="codehilite"><pre><span class="o">**</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">dist</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">/</span><span class="n">repos</span><span class="o">/</span><span class="n">dist</span><span class="o">/</span><span class="n">release</span><span class="o">/</span><span class="n">directory</span><span class="o">/</span><span class="n">mavibot</span><span class="o">/</span><span class="n">dist</span><span class="o">/</span>$<span class="p">(</span><span class="n">version</span><span class="p">)</span><span class="o">**</span>
+</pre></div>
+
+
<p>The best solution would be to checkout the directory in people.apache.org, to copy the packages in the right place, and to check in the changes :</p>
-<p>$ ssh people.apache.org</p>
-<h1 id="svn-co-httpsdistapacheorgreposdistreleasedirectorymavibotdist-api-dist">svn co https://dist.apache.org/repos/dist/release/directory/mavibot/dist/ api-dist</h1>
-<h1 id="cd-api-dist">cd api-dist</h1>
-<h1 id="mkdir-wzxhzdk22">mkdir <version></h1>
-<h1 id="cp-public_htmlmavibot-wzxhzdk23-wzxhzdk24">cp ../public_html/mavibot-<version>/* <version></h1>
-<h1 id="svn-ci-wzxhzdk25">svn ci <version></h1>
-<p>...</p>
-<h1 id="exit">exit</h1>
-<p>$</p>
-<p>The packages should now be available on http://www.us.apache.org/dist/directory/mavibot/dist/<version></p>
+<div class="codehilite"><pre>$ ssh people.apache.org
+# svn co https://dist.apache.org/repos/dist/release/directory/mavibot/dist/ api-dist
+# cd api-dist
+# mkdir <version>
+# cp ../public_html/mavibot-<version>/* <version>
+# svn ci <version>
+...
+# exit
+$
+</pre></div>
+
+
+<p>The packages should now be available on <strong>http://www.us.apache.org/dist/directory/mavibot/dist/<version></strong></p>
<h2 id="deploy-the-javadocs-and-xref">Deploy the Javadocs and XRef</h2>
<p>We now can deploy the generated Javadoc and cross-reference pages. They are generated in the following directory :</p>
-<p>target/checkout/target/site</p>
+<div class="codehilite"><pre>target/checkout/target/site
+</pre></div>
+
+
<p>We will copy two directories :</p>
-<div class="codehilite"><pre><span class="n">apidocs</span>
-<span class="n">xref</span>
+<div class="codehilite"><pre>apidocs
+xref
</pre></div>
<h3 id="staging-or-production">Staging or Production?</h3>
<p>Those files will be stored on the production server only !!! And some extra caution must be taken not to delete them when we will publish the staging site too...</p>
<p>First of all, you must checkout the two CMS store for the site : staging and revision.</p>
-<p>$ cd ~/apacheds
+<div class="codehilite"><pre>$ cd ~/apacheds
$ svn co https://svn.apache.org/repos/infra/websites/production/directory/trunk staging
...
$ svn co https://svn.apache.org/repos/infra/websites/production/directory production
- ...</p>
+ ...
+</pre></div>
+
+
<p>Now, you will first add the directory for the newly generated version :</p>
-<p>$ cd ~/apacheds/production/content/mavibot/gen-docs
-$ mkdir <version>
-$ svn add <version></p>
+<div class="codehilite"><pre>$ cd ~/apacheds/production/content/mavibot/gen-docs
+$ mkdir <version>
+$ svn add <version>
+</pre></div>
+
+
<p>Then copy the generated docs :</p>
-<p>$ cp -r ~/apacheds/trunks/mavibot/target/checkout/target/site/apidocs ~/apacheds/production/content/mavibot/gen-docs/<version>
-$ cp -r ~/apacheds/trunks/mavibot/target/checkout/target/site/xref ~/apacheds/production/content/mavibot/gen-docs/<version>
-$ </p>
+<div class="codehilite"><pre>$ cp -r ~/apacheds/trunks/mavibot/target/checkout/target/site/apidocs ~/apacheds/production/content/mavibot/gen-docs/<version>
+$ cp -r ~/apacheds/trunks/mavibot/target/checkout/target/site/xref ~/apacheds/production/content/mavibot/gen-docs/<version>
+$
+</pre></div>
+
+
<p>You have to check in those directories :</p>
-<p>$ svn add <version>/*
-$ svn ci <version> -m "Injected <version> javadocs"</p>
-<p>Now, you have to update the staging site :
-extpaths.txt</p>
+<div class="codehilite"><pre>$ svn add <version>/*
+$ svn ci <version> -m "Injected <version> javadocs"
+</pre></div>
+
+
+<p>Now, you have to update the staging site :</p>
+<div class="codehilite"><pre>extpaths.txt
+</pre></div>
+
+
<p>This file list the file on the production site that will not be overriden by the publication of the staging site. It has to be updated</p>
-<p>$ cd ~/apacheds/staging/content/
-$ vi extpaths.txt</p>
+<div class="codehilite"><pre>$ cd ~/apacheds/staging/content/
+$ vi extpaths.txt
+</pre></div>
+
+
<p>Add the following line :</p>
-<p>...</p>
-<h1 id="mavibot">Mavibot</h1>
-<p>mavibot/gen-docs/<version>
-...</p>
-<p>then save and check in the file
-.htaccess</p>
+<div class="codehilite"><pre>...
+# Mavibot
+mavibot/gen-docs/<version>
+...
+</pre></div>
+
+
+<p>then save and check in the file <strong>.htaccess</strong></p>
<p>We also have to update this file :</p>
-<p>$ cd ~/apacheds/staging/content/mavibot/gen-docs
-$ vi .htaccess</p>
+<div class="codehilite"><pre>$ cd ~/apacheds/staging/content/mavibot/gen-docs
+$ vi .htaccess
+</pre></div>
+
+
<p>And update the two last lines to refer to the version you've just released :</p>
-<p>RewriteRule ^latest$ <version>/
-RewriteRule ^latest/(.*)$ <version>/$1</p>
+<div class="codehilite"><pre>RewriteRule ^latest$ <version>/
+RewriteRule ^latest/(.*)$ <version>/$1
+</pre></div>
+
+
<p>Save and commit the file.</p>
<h2 id="update-the-web-site">Update the web site</h2>
<p>You can now update the site, add a news on the front page, and publish the site.</p>
<h2 id="inform-the-world">Inform the world !</h2>
<p>After 24h, you can now inform the world about the release.</p>
-<p>Send a mail to the users and dev mailing list, and one to the announce@apacge.org.</p>
+<p>Send a mail to the users and dev mailing list, and one to the announce@apache.org list.</p>
<p>You are done !</p>