CVE announcement
1 file changed
tree: b6f5c0d63431240b6365e1d54b99c372f1ec0e8c
  1. .asf.yaml
  2. LICENSE
  3. NOTICE
  4. README.md
  5. builder/
  6. site/
  7. src/
README.md

Note: the branch trunk is obsolete. Please use the master branch.


The Apache Velocity Project

dev@velocity.apache.org

The Apache Velocity Site

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 Git 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/contributor and want to update the site.

Building the Site

Apache Velocity uses Apache Content Management System to build the site. The whole process of buiding the site is automated with a Docker based build script.

The required software you need is:

*) Git - to checkout and commit *) Docker - builder.sh uses it to run Apache CMS that generates HTML out of the Markdown files *) A text editor - to edit the Markdown files *) A web browser - to review the changes in the generated HTML files

Steps:

  1. Create a parent folder for the local Git clones

export VELOCITY_PARENT_FOLDER=“/path/to/velocity” mkdir -p $VELOCITY_PARENT_FOLDER cd $VELOCITY_PARENT_FOLDER

  1. Clone the GitHub repository for editing the Markdown files

git clone --single-branch --branch master git@github.com:[YOUR_GITHUB_ID]/velocity-site.git

  1. Edit the Markdown files

$VELOCITY_PARENT_FOLDER/velocity-site edit src/content/[FILE].mdtext

  1. Build the HTML files

./builder/bin/builder.sh

  1. Check the generated HTML locally

open $VELOCITY_PARENT_FOLDER/velocity-site-prod/index.html in your favorite web browser and navigate around to review your changes

  1. Commit your changes

cd $VELOCITY_PARENT_FOLDER/velocity-site git commit -a -m “Some message explaining your changes” git push

  1. Create a Pull Request in GitHub UI

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):

[...] velocity.apache.org {your apache user id} [...]

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

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 the helper modules. Please go to the directory where you found this README and run “mvn”. Afterwards the site should build fine.

An error message like this:

[ERROR] BUILD ERROR [INFO] ------------------------------------------------------------------------ [INFO] Internal error in the plugin manager executing goal ‘org.apache.maven.plugins:maven-site-plugin:2.0-SNAPSHOT:run’: Unable to find the mojo ‘org.apache.maven.plugins:maven-site-plugin:2.0-SNAPSHOT:run’ in the plugin ‘org.apache.maven.plugins:maven-site-plugin’

means that you are probably using Apache Maven 2.0.4 and either forgot to add the workaround described above when trying to build the site or forgot to remove the extensions as described above when trying to execute site:run or site:deploy.

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.