svn commit: r486328 - /velocity/site/README.txt

[he...@apache.org]

Author: henning
Date: Tue Dec 12 13:36:16 2006
New Revision: 486328

URL: http://svn.apache.org/viewvc?view=rev&rev=486328
Log:
Add a README for building the site.

Added:
    velocity/site/README.txt   (with props)

Added: velocity/site/README.txt
URL: http://svn.apache.org/viewvc/velocity/site/README.txt?view=auto&rev=486328
==============================================================================
--- velocity/site/README.txt (added)
+++ velocity/site/README.txt Tue Dec 12 13:36:16 2006
@@ -0,0 +1,93 @@
+--------------------
+Apache Velocity Site
+--------------------
+
+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.
+
+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 two modules: The Skin and the Site itself. These
+are represented by the two sub-modules in this directory.
+
+
+Create the Apache Velocity Site Skin
+------------------------------------
+
+To build the site, you need the skin. This is currently not available
+from the Maven repositories. Please install it locally by entering the
+"skin" directory and running "mvn". This installs the skin on your
+local maven repository.
+
+This step needs to be done only once unless you want to change the
+skin (and the look-and-feel of the site).
+
+
+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:
+
+[...]
+<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
+---------------
+
+The following error message when building the site:
+
+[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
+
+means that you have not installed the skin locally. Please go to the
+skin directory and run "mvn".
+
+
+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 <de...@velocity.apache.org>.
+

Propchange: velocity/site/README.txt
------------------------------------------------------------------------------
    svn:eol-style = native