velocity-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henn...@apache.org
Subject svn commit: r491019 - in /velocity/site: README.txt site/src/site/apt/site-building.apt site/src/site/site.xml site/src/site/velocity/xdoc/who-we-are.xml site/src/site/xdoc/guidelines.xml
Date Fri, 29 Dec 2006 14:26:26 GMT
Author: henning
Date: Fri Dec 29 06:26:25 2006
New Revision: 491019

URL: http://svn.apache.org/viewvc?view=rev&rev=491019
Log:
Fix up guidelines, add site building document.


Added:
    velocity/site/site/src/site/apt/site-building.apt
Removed:
    velocity/site/site/src/site/xdoc/guidelines.xml
Modified:
    velocity/site/README.txt
    velocity/site/site/src/site/site.xml
    velocity/site/site/src/site/velocity/xdoc/who-we-are.xml

Modified: velocity/site/README.txt
URL: http://svn.apache.org/viewvc/velocity/site/README.txt?view=diff&rev=491019&r1=491018&r2=491019
==============================================================================
--- velocity/site/README.txt (original)
+++ velocity/site/README.txt Fri Dec 29 06:26:25 2006
@@ -1,56 +1,75 @@
---------------------
-Apache Velocity Site
---------------------
+ ----
+ The Apache Velocity Project
+ ----
+ dev@velocity.apache.org
 
-The Apache Velocity Site is what you get when you visit
-http://velocity.apache.org/. It is the envelope site for all Apache
-Velocity sub projects.
+The Apache Velocity Site
+========================
 
-In short: This svn repository is only interesting for you if you
+Introduction
+------------
 
-a) want to re-create the Apache Velocity site on your local computer or intranet.
+ The Apache Velocity Site is what you get when you visit
+ http://velocity.apache.org/ (our homepage). It is the envelope site for all Apache
+ Velocity sub projects.
 
-b) are an Apache Velocity committer and want to update the site. 
+ In short: This svn repository is only interesting for you if you
+
+ a) want to re-create the Apache Velocity site on your local computer or intranet.
+
+ b) are an Apache Velocity committer and want to update the site. 
 
 
 Building the Site
-=================
+-----------------
+
+ Apache Velocity uses Apache Maven 2 to build the site. It has been
+ tested with Maven 2.0.4 and should work with all versions beyond.
+
+ The site consists of multiple modules: The Site itself and some
+ helpers that must be installed in your local Maven repository. These
+ extensions are currently not present in the remote Maven
+ 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
+=====================================================================
 
-Apache Velocity uses Apache Maven 2 to build the site. It has been
-tested with Maven 2.0.4 and should work with all versions beyond.
+ The site is available from
+ http://svn.apache.org/repos/asf/velocity/site/ (The Apache Velocity
+ Site repository). You need a Subversion client installed to download
+ the site source code onto your computer.
 
-The site consists of multiple modules: The Site itself and some
-helpers that must be installed in your local Maven repository. These
-extensions are currently not present in the remote Maven repositories,
-so if you do not install them, the site build itself will fail.
 
 
 Create the Apache Velocity Site Helper modules
 ----------------------------------------------
 
-To build the site, you need the helper modules installed locally. 
+ To build the site, you need the helper modules installed locally. 
 
-The helper modules have been organized as a Maven reactor build. You
-can install them by running "mvn" from the directory where you found
-this README.
+ The helper modules have been organized as a Maven reactor build. You
+ can install them by running "mvn" from the directory where you found
+ this README.
 
-You need to install these only once unless the dependencies of the
-site have changed which should only happen very rarely.
+ You need to install these only once unless the dependencies of the
+ site have changed which should only happen very rarely.
 
 
 Create the Apache Velocity Site
 -------------------------------
 
-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).
-
-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
-velocity.apache.org, you need a server definition in your local
-settings.xml file:
+ 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
+ automatic mirror selection).
+
+ 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:
 
 [...]
 <servers>
@@ -61,13 +80,13 @@
 </servers>
 [...]
 
-Then you can run "mvn site:deploy" to re-deploy the web site.
+ Then you can run "mvn site:deploy" to re-deploy the web site.
 
 
 Troubleshooting
 ---------------
 
-One of the following error messages when building the site:
+ When building the site, you might get one or more error messages like this:
 
 [INFO] ------------------------------------------------------------------------
 [ERROR] BUILD FAILURE
@@ -83,7 +102,7 @@
 
   org.apache.velocity:velocity-site-skin:jar:1.0.0
 
-or
+ or
 
 Missing:
 ----------
@@ -100,15 +119,15 @@
         2) org.apache.velocity:doxia-velocity-renderer:jar:0.0.1
 
 
-Both messages mean that you neglected to install the helper
-modules. Please go to the directory where you found this README and
-run "mvn". Afterwards the site should build fine.
+ Both messages mean that you neglected to install the helper
+ modules. Please go to the directory where you found this README and
+ run "mvn". Afterwards the site should build fine.
 
 
 Questions and contact
 ---------------------
 
-If you have questions about the Apache Velocity Site building process,
-please ask the Velocity developers on the Velocity Developers mailing
-list at <dev@velocity.apache.org>.
+ If you have questions about the Apache Velocity Site building
+ process, please ask the Velocity developers on the Velocity
+ Developers mailing list at <dev@velocity.apache.org>.
 

Added: 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=auto&rev=491019
==============================================================================
--- velocity/site/site/src/site/apt/site-building.apt (added)
+++ velocity/site/site/src/site/apt/site-building.apt Fri Dec 29 06:26:25 2006
@@ -0,0 +1,134 @@
+ ----
+ The Apache Velocity Project
+ ----
+ dev@velocity.apache.org
+
+The Apache Velocity Site
+
+ <<WARNING! This document might be out of date!>> For the latest
+ information on how to build the Apache Velocity Site, please check
+ out the actual {{{http://svn.apache.org/repos/asf/velocity/site/README.txt}README
+ file}} which contains the latest information. This document has
+ been created from the README and is not updated as often.
+
+* Introduction
+
+ The Apache Velocity Site is what you get when you visit
+ {{{http://velocity.apache.org/}our homepage}}. It is the envelope site
+ for all Apache Velocity sub projects.
+
+ In short: This svn repository is only interesting for you if you
+
+ [[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. 
+
+
+* Building the Site
+
+ Apache Velocity uses {{{http://maven.apache.org/}Apache Maven 2}} to
+ build the site. It has been tested with Maven 2.0.4 and should work
+ with all versions beyond.
+
+ The site consists of multiple modules: The Site itself and some
+ helpers that must be installed in your local Maven repository. These
+ extensions are currently not present in the remote Maven
+ 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
+
+ The site is available from
+ {{{http://svn.apache.org/repos/asf/velocity/site/}The Apache Velocity
+ Site repository}}. You need a Subversion client installed to download
+ the site source code onto your computer.
+
+
+* {install-helpers}Create the Apache Velocity Site Helper modules
+
+ To build the site, you need the helper modules installed locally. 
+
+ The helper modules have been organized as a Maven reactor build. You
+ can install them by running <<<mvn>>> from the directory where you found
+ this README.
+
+ You need to install these only once unless the dependencies of the
+ site have changed which should only happen very rarely.
+
+
+* Create the Apache Velocity Site
+
+ 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
+ automatic mirror selection).
+
+ 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:
+
++--
+<servers>
+  <server>
+    <id>velocity.apache.org</id>
+    <username>{your apache user id}</username>
+  </server>
+</servers>
++--
+
+Then you can run <<<mvn site:deploy>>> to re-deploy the web site.
+
+
+* Troubleshooting
+
+ When building the site, you might get one or more error messages like this:
+
++--
+[INFO] ------------------------------------------------------------------------
+[ERROR] BUILD FAILURE
+[INFO] ------------------------------------------------------------------------
+[INFO] The skin does not exist: Unable to download the artifact from any repository
+
+Try downloading the file manually from the project website.
+
+Then, install it using the command:
+    mvn install:install-file -DgroupId=org.apache.velocity -DartifactId=velocity-site-skin
\
+        -Dversion=1.0.0 -Dpackaging=jar -Dfile=/path/to/file
+
+
+  org.apache.velocity:velocity-site-skin:jar:1.0.0
++--
+
+ or
+
++--
+Missing:
+----------
+1) org.apache.velocity:doxia-velocity-renderer:jar:0.0.1
+
+  Try downloading the file manually from the project website.
+
+  Then, install it using the command:
+      mvn install:install-file -DgroupId=org.apache.velocity -DartifactId=doxia-velocity-renderer
\
+          -Dversion=0.0.1 -Dpackaging=jar -Dfile=/path/to/file
+
+  Path to dependency:
+        1) org.apache.velocity:velocity-site:jar:1.0.0
+        2) org.apache.velocity:doxia-velocity-renderer:jar:0.0.1
++--
+
+ Both messages mean that you neglected to {{{#install-helpers}install the helper
+ modules}}. Please go to the directory where you found this README file and
+ run <<<mvn>>>. Afterwards the site should build fine.
+
+
+* Questions and contact
+
+ If you have questions about the Apache Velocity Site building
+ process, please ask the Velocity developers on the
+ {{{contact.html#dev}Velocity Developers mailing list}}.
+

Modified: velocity/site/site/src/site/site.xml
URL: http://svn.apache.org/viewvc/velocity/site/site/src/site/site.xml?view=diff&rev=491019&r1=491018&r2=491019
==============================================================================
--- velocity/site/site/src/site/site.xml (original)
+++ velocity/site/site/src/site/site.xml Fri Dec 29 06:26:25 2006
@@ -66,8 +66,8 @@
 
     <menu name="Developer Resources">
       <item name="Coding Standards" href="http://wiki.apache.org/jakarta-velocity/CodeStandards"/>
-      <item name="Project guidelines" href="guidelines.html"/>
-      <item name="Site building" href="http://wiki.apache.org/jakarta-velocity/VelocitySite"/>
+      <item name="Project guidelines" href="how-it-works.html#Project Guidelines"/>
+      <item name="Site building" href="site-building.html"/>
     </menu>
 
     <menu name="Apache Reference">

Modified: velocity/site/site/src/site/velocity/xdoc/who-we-are.xml
URL: http://svn.apache.org/viewvc/velocity/site/site/src/site/velocity/xdoc/who-we-are.xml?view=diff&rev=491019&r1=491018&r2=491019
==============================================================================
--- velocity/site/site/src/site/velocity/xdoc/who-we-are.xml (original)
+++ velocity/site/site/src/site/velocity/xdoc/who-we-are.xml Fri Dec 29 06:26:25 2006
@@ -66,7 +66,7 @@
         </table>
       </section>
 
-      <section name="Apache Velocity Developers">
+      <section name="Apache Velocity Committers">
 
         <table>
            <tr>



Mime
View raw message