velocity-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henn...@apache.org
Subject svn commit: r526850 - in /velocity/site: README.txt site/src/site/apt/site-building.apt
Date Mon, 09 Apr 2007 17:38:02 GMT
Author: henning
Date: Mon Apr  9 10:38:00 2007
New Revision: 526850

URL: http://svn.apache.org/viewvc?view=rev&rev=526850
Log:
Update site building docs.


Modified:
    velocity/site/README.txt
    velocity/site/site/src/site/apt/site-building.apt

Modified: velocity/site/README.txt
URL: http://svn.apache.org/viewvc/velocity/site/README.txt?view=diff&rev=526850&r1=526849&r2=526850
==============================================================================
--- velocity/site/README.txt (original)
+++ velocity/site/README.txt Mon Apr  9 10:38:00 2007
@@ -25,12 +25,7 @@
 
  Apache Velocity uses Apache Maven 2 to build the site.
 
- Due to a problem in the Maven 2.0.x core, the site needs to be
- built with a version of at least Maven 2.0.5 or the development
- snapshot 2.0.5-SNAPSHOT.
-
- If you want to stick to the released 2.0.4 version, there is a
- workaround described below.
+ It requires at least Maven 2.0.5 to build, Maven 2.0.6 is recommended.
 
  The site consists of multiple modules: The Site itself and some
  helpers that must be installed in your local Maven repository. These
@@ -39,8 +34,8 @@
  will fail.
 
 
-Checking out the Site module from the Velocity Source Code Repository
-=====================================================================
+Checking the Site module out of the Velocity Source Code Repository
+===================================================================
 
  The site is available from
  http://svn.apache.org/repos/asf/velocity/site/ (The Apache Velocity
@@ -64,33 +59,6 @@
 Create the Apache Velocity Site
 -------------------------------
 
- *BEGIN WORKAROUND for Maven 2.0.4*
-
- To resolve all dependencies for the site building, add the following
- block to the <extensions> section of the site POM.
-
- <extensions>
- ...
-   <extension>
-     <groupId>org.apache.maven.plugins</groupId>
-     <artifactId>maven-site-plugin</artifactId>
-     <version>2.0-SNAPSHOT</version>
-   </extension>
- </extensions>
-
- Now you can build the site as described below.
-
- However the bug inside maven prevents you from running the site
- locally using site:run or deploying it to velocity.apache.org using
- site:deploy. If you want to do so, you must *remove all extensions*
- (or just comment them out) from the site POM.
-
- Does all of that suck? Yes, it does. So please lobby for a quick
- release of Maven 2.0.5 or go through the journey of building it
- locally from scratch. Even better, ask another person to do it. ;-).
-
- *END WORKAROUND for Maven 2.0.4*
-
  To build the site, enter the "site" directory and run "mvn" (the
  default goal here is "site-post" which generates the site and also
  installs a few extra files (e.g. the download.cgi script for
@@ -99,9 +67,27 @@
  If you want to re-create the site locally, you can now enter "mvn
  site:run" and point a web browser at "localhost:8080".
 
- If you are an Apache Velocity committer and want to deploy the site
- to our web site at velocity.apache.org, you need a server definition
- in your local Maven settings.xml file:
+
+Deploy the Apache Velocity Site
+-------------------------------
+
+ What you see is (almost) what you get. While the site builds using
+ stock Apache Maven 2.0.6 and also all plugins can be built and used,
+ the full functionality of what you see depends of a few patches to
+ Maven Doxia and the site and changes plugins.
+
+ It is therefore recommended that you do not deploy the site from
+ your local computer but log onto velocity.zones.apache.org (as a 
+ committer, you can get an account here by just asking on the PMC
+ list) and run the following commands:
+
+ newgrp velocity (this will open a new shell)
+ /export/home/velocity/bin/build_velocity_site.sh
+
+ This will check out the latest version of the site into a staging
+ directory, build it and deploy it to velocity.apache.org. You must
+ have a local Maven settings file in your home directory, though
+ (typically in ~/.m2/settings.xml):
 
 [...]
 <servers>
@@ -112,8 +98,16 @@
 </servers>
 [...]
 
- Then you can run "mvn site:deploy" to re-deploy the web site.
+ The patches required to Doxia and the plugins can be reviewed by
+ running the following commands on velocity.zones.apache.org
 
+ ( cd /export/home/velocity/scratch/maven-2/doxia/doxia ; svn diff )
+ ( cd /export/home/velocity/scratch/maven-2/doxia/doxia-sitetools ; svn diff )
+ ( cd /export/home/velocity/scratch/maven-2/plugins ; svn diff )
+
+ The various patches are open at the Maven bug tracker as MNG-2874,
+ MCHANGES-67, MCHANGES-66, DOXIA-91, DOXIA-78.
+ 
 
 Troubleshooting
 ---------------

Modified: velocity/site/site/src/site/apt/site-building.apt
URL: http://svn.apache.org/viewvc/velocity/site/site/src/site/apt/site-building.apt?view=diff&rev=526850&r1=526849&r2=526850
==============================================================================
--- velocity/site/site/src/site/apt/site-building.apt (original)
+++ velocity/site/site/src/site/apt/site-building.apt Mon Apr  9 10:38:00 2007
@@ -21,7 +21,7 @@
 
  [[a]] want to re-create the Apache Velocity site on your local computer or intranet.
 
- [[b]] are an {{{who-we-are.html#Apache Velocity Committers}Apache Velocity committer}} and
want to update the site. 
+ [[b]] are an {{{who-we-are.html#apache_velocity_committers}Apache Velocity committer}} and
want to update the site. 
 
 
 * Building the Site
@@ -29,12 +29,7 @@
  Apache Velocity uses {{{http://maven.apache.org/}Apache Maven 2}} to
  build the site.
 
- Due to a problem in the Maven 2.0.x core, the site needs to be
- built with a version of at least Maven 2.0.5 or the development
- snapshot 2.0.5-SNAPSHOT.
-
- If you want to stick to the released 2.0.4 version, there is a
- workaround described below.
+ It requires at least Maven 2.0.5 to build, Maven 2.0.6 is recommended.
 
  The site consists of multiple modules: The Site itself and some
  helpers that must be installed in your local Maven repository. These
@@ -42,8 +37,7 @@
  repositories, so if you do not install them, the site build itself
  will fail.
 
-
-* Checking out the Site module from the Velocity Source Code Repository
+* Checking the Site module out of the Velocity Source Code Repository
 
  The site is available from
  {{{http://svn.apache.org/repos/asf/velocity/site/}The Apache Velocity
@@ -65,36 +59,6 @@
 
 * Create the Apache Velocity Site
 
-** {WORKAROUND for Maven 2.0.4}
-
- To resolve all dependencies for the site building, add the following
- block to the <<<\<extensions\>>>> section of the site POM.
-
-+--
- <extensions>
- ...
-   <extension>
-     <groupId>org.apache.maven.plugins</groupId>
-     <artifactId>maven-site-plugin</artifactId>
-     <version>2.0-SNAPSHOT</version>
-   </extension>
- </extensions>
-+--
-
- Now you can build the site as described below.
-
- However the bug inside maven prevents you from running the site
- locally using <<<site:run>>> or deploying it to <<<velocity.apache.org>>>
using
- <<<site:deploy>>>. If you want to do so, you must <remove all extensions>
- (or just comment them out) from the site POM.
-
- Does all of that suck? Yes, it does. So please lobby for a quick
- release of Maven 2.0.5 or go through the journey of building it
- locally from scratch. Even better, ask another person to do it. ;-).
-
-
-** Create the Apache Velocity Site using Apache Maven
-
  To build the site, enter the <site> directory and run <<<mvn>>>
(the
  default goal here is <site-post> which generates the site and also
  installs a few extra files (e.g. the <<<download.cgi>>> script for
@@ -103,9 +67,28 @@
  If you want to re-create the site locally, you can now enter 
  <<<mvn site:run>>> and point a web browser at {{{http://localhost:8080/}your
local web server}}.
 
- If you are an Apache Velocity committer and want to deploy the site
- to our web site at velocity.apache.org, you need a server definition
- in your local Maven <<<settings.xml>>> file:
+* Deploy the Apache Velocity Site
+
+ What you see is (almost) what you get. While the site builds using
+ stock Apache Maven 2.0.6 and also all plugins can be built and used,
+ the full functionality of what you see depends of a few patches to
+ Maven Doxia and the site and changes plugins.
+
+ It is therefore recommended that you do not deploy the site from
+ your local computer but log onto <velocity.zones.apache.org> (as a 
+ committer, you can get an account here by just asking on the PMC
+ list) and run the following commands:
+
++--
+newgrp velocity (this will open a new shell)
+/export/home/velocity/bin/build_velocity_site.sh
++--
+
+ This will check out the latest version of the site into a staging
+ directory, build it and deploy it to <velocity.apache.org>. You must
+ have a local Maven settings file in your home directory, though
+ (typically in <~/.m2/settings.xml>):
+
 
 +--
 <servers>
@@ -116,8 +99,21 @@
 </servers>
 +--
 
- Then you can run <<<mvn site:deploy>>> to re-deploy the web site.
+ The patches required to Doxia and the plugins can be reviewed by
+ running the following commands on velocity.zones.apache.org
+
++--
+ ( cd /export/home/velocity/scratch/maven-2/doxia/doxia ; svn diff )
+ ( cd /export/home/velocity/scratch/maven-2/doxia/doxia-sitetools ; svn diff )
+ ( cd /export/home/velocity/scratch/maven-2/plugins ; svn diff )
++--
 
+ The various patches are open at the Maven bug tracker as
+ {{{http://jira.codehaus.org/browse/MNG-2874}MNG-2874}},
+ {{{http://jira.codehaus.org/browse/MCHANGES-67}MCHANGES-67}},
+ {{{http://jira.codehaus.org/browse/MCHANGES-66}MCHANGES-66}},
+ {{{http://jira.codehaus.org/browse/DOXIA-91}DOXIA-91}} and
+ {{{http://jira.codehaus.org/browse/DOXIA-78}DOXIA-78}}.
 
 * Troubleshooting
 



Mime
View raw message