This is an automated email from the ASF dual-hosted git repository. cbrisson pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/velocity-site.git
commit d3885d8fc1c855f479035ddfa352d13ee70e32a6 Author: Claude Brisson <[email protected]> AuthorDate: Sat Feb 27 13:50:01 2021 +0100 [site] Lots of little fixes (svn/git, links) --- src/content/engine/2.0/build.mdtext | 22 ++++++----- src/content/engine/2.0/developer-guide.mdtext | 2 +- src/content/engine/2.0/index.mdtext | 12 ++---- src/content/engine/2.0/source-repository.mdtext | 45 ++--------------------- src/content/engine/2.1/build.mdtext | 18 +++++---- src/content/engine/2.1/developer-guide.mdtext | 7 ++-- src/content/engine/2.1/index.mdtext | 16 +++----- src/content/engine/2.1/source-repository.mdtext | 45 ++--------------------- src/content/engine/2.2/build.mdtext | 12 +++--- src/content/engine/2.2/developer-guide.mdtext | 2 +- src/content/engine/2.2/index.mdtext | 14 ++----- src/content/engine/2.2/source-repository.mdtext | 45 ++--------------------- src/content/engine/devel/build.mdtext | 12 +++--- src/content/engine/devel/developer-guide.mdtext | 2 +- src/content/engine/devel/getting-started.mdtext | 2 +- src/content/engine/devel/index.mdtext | 16 +++----- src/content/engine/devel/source-repository.mdtext | 45 ++--------------------- 17 files changed, 75 insertions(+), 242 deletions(-) diff --git a/src/content/engine/2.0/build.mdtext b/src/content/engine/2.0/build.mdtext index 5215913..cc925fa 100644 --- a/src/content/engine/2.0/build.mdtext +++ b/src/content/engine/2.0/build.mdtext @@ -2,9 +2,9 @@ Title: Apache Velocity Engine - Building ## Installation -Velocity runs on a variety of platforms that have installed the Java Virtual Machine. A Java Development Kit version 1.7+ is required to compile Velocity from its source code (as it is to run it). +Velocity runs on a variety of platforms that have installed the Java Virtual Machine. A Java Development Kit version 1.8+ is required to compile Velocity from its source code (as it is to run it). -Everything required to build Velocity comes with the distribution, which can be obtained from [Subversion](http://svn.apache.org/repos/asf/velocity/engine/) or from the [main distribution](/download.cgi#engine). However, you will need to install [Maven](http://maven.apache.org/) to build the Velocity sources. +Everything required to build Velocity comes with the distribution, which can be obtained from [Apache git](https://gitbox.apache.org/repos/asf/velocity-engine.git), [github](https://github.com/apache/velocity-engine.git) (handy to submit pull requests) or from the [main distribution](/download.cgi#engine). However, you will need to install [Maven](http://maven.apache.org/) to build the Velocity sources. [Maven](http://maven.apache.org/) is also an Apache project. To build Apache Velocity, you need at least Version 3.0.5 of Apache Maven. @@ -12,18 +12,20 @@ Everything required to build Velocity comes with the distribution, which can be To build Velocity we require [Maven](http://maven.apache.org/) version 3.0.5 or higher to perform the build process. We assume that you have followed Maven's installation instructions and have it properly installed. -## Building +## Building from Sources -In each case below, it is assumed that you were successful in [downloading](/download.cgi#engine) and unpacking the distribution source or [checking out the sources from Subversion](/download.cgi#source-code-repository): +In each case below, it is assumed that you were successful in [checking out the sources from github](/download.cgi#source-code-repository): :::shell - svn checkout https://svn.apache.org/repos/asf/velocity/engine/tags/2.0 velocity-2.0 - cd velocity-2.0 - mvn install + git clone https://github.com/apache/velocity-engine.git velocity-engine + cd velocity-engine + mvn install -Executing this script will create a **target** directory within the velocity-2.0 directory. Each subdirectory containing a module of Velocity will contain a "target" directory too, containing all built jars. +Executing this script will create a **target** directory within the velocity-engine directory. Each subdirectory containing a module of Velocity will contain a "target" directory too, containing all built jars. -Refer to Maven documentation for all phases you can invoke. +After a successful build with the above command, your Velocity build will be available in your local Maven repository. + +Refer to Maven documentation for alternate commands you can invoke. If you find a problem, do not hesitate to ask the Velocity community -via our [mail lists](/contact.html). +via our [mailing lists](/contact.html). diff --git a/src/content/engine/2.0/developer-guide.mdtext b/src/content/engine/2.0/developer-guide.mdtext index c9f1414..a0de02c 100644 --- a/src/content/engine/2.0/developer-guide.mdtext +++ b/src/content/engine/2.0/developer-guide.mdtext @@ -19,7 +19,7 @@ We suggest you read this article on [getting started with web applications](weba You can download the latest release version of the [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the latest source, you can do so via the git source control system and/or our github.com mirror. You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). diff --git a/src/content/engine/2.0/index.mdtext b/src/content/engine/2.0/index.mdtext index 4be7589..161aaa1 100644 --- a/src/content/engine/2.0/index.mdtext +++ b/src/content/engine/2.0/index.mdtext @@ -18,13 +18,7 @@ Older releases are archived at the [Apache Velocity archives](http://archive.apa ## Where do I get nightly snapshots? -<!-- -Nightly snapshots of the Velocity subversion source code tree can be found on our [nightly snapshot site(http://vc.apache.org/snapshots/velocity/). - -If you are willing to risk getting dirty, we invite you to try the nightly snapshot to see the current state of affairs. (and help out!) [Public subversion access](http://www.apache.org/dev/version-control.html) is also available. ---> - -Nightly snapshots aren't currently activated, but you can build the latest version using the [Public subversion access](http://www.apache.org/dev/version-control.html), and you can find the latest published snapshot on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). +Nightly snapshots aren't currently activated, but you can [build the latest version](build.html), and you can find the latest published snapshot on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). **Caveat!** These snapshots are generated automatically from the project source code repository. As this is our live development workspace, there are no guarantees as to what you will find there, although we do our best to maintain a buildable source tree. If you are looking for the stable supported release, please use the current release of Velocity. @@ -36,5 +30,5 @@ The Velocity project appreciates any contributions, including documentation help + Report bugs, ask questions, and help new users on the [Velocity mailing lists](http://velocity.apache.org/contact.html). + There's a list of issues waiting to be addressed in [our bug tracker](https://issues.apache.org/jira/browse/VELOCITY). -+ [Our wiki](http://wiki.apache.org/velocity/velocity) has a large collection of community written content. Add your own article or contribute to the FAQ! -+ Read-only access to the Subversion repository is available both [online](http://svn.apache.org/repos/asf/velocity/engine/trunk/) and with a [Subversion client](http://www.apache.org/dev/version-control.html). ++ [Our wiki](https://wiki.apache.org/velocity/velocity) has a large collection of community written content. Add your own article or contribute to the FAQ! ++ Read-only access to the git repository is available both [online](https://github.com/apache/velocity-engine) and with a [Git client](https://www.apache.org/dev/version-control.html). diff --git a/src/content/engine/2.0/source-repository.mdtext b/src/content/engine/2.0/source-repository.mdtext index a5ec58f..065bb6b 100644 --- a/src/content/engine/2.0/source-repository.mdtext +++ b/src/content/engine/2.0/source-repository.mdtext @@ -1,49 +1,12 @@ ## Overview -This project uses [Subversion](http://subversion.tigris.org) to manage its source code. Instructions on Subversion use can be found at [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/). +This project uses [Git](https://git-scm.com/) to manage its source code. Instructions on how to use git can be found at [Git documentation](https://git-scm.com/doc). ## Web Access -The following is a link to the online source repository. - -[http://svn.apache.org/viewvc/velocity/engine/trunk](http://svn.apache.org/viewvc/velocity/engine/trunk) +Apache gitbox repository: [https://gitbox.apache.org/repos/asf?p=velocity-engine.git](https://gitbox.apache.org/repos/asf?p=velocity-engine.git) {.frame} -## Anonymous access - -The source can be checked out anonymously from SVN with this command: - - :::shell - $ svn checkout http://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -## Developer access - -Everyone can access the Subversion repository via HTTP, but Committers must checkout the Subversion repository via HTTPS. - - :::shell - $ svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password) - - :::shell - $ svn commit --username your-username -m "A message" - -## Access from behind a firewall - -For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion repository, you can try to access it via the developer connection: - - :::shell - $ svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -## Access through a proxy - -The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The file's location depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.) - -There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created. - -Example: Edit the 'servers' file and add something like: +Github mirror: [https://github.com/apache/velocity-engine](https://github.com/apache/velocity-engine). +{.frame} - :::properties - [global] - http-proxy-host = your.proxy.name - http-proxy-port = 3128 diff --git a/src/content/engine/2.1/build.mdtext b/src/content/engine/2.1/build.mdtext index 841b401..cc925fa 100644 --- a/src/content/engine/2.1/build.mdtext +++ b/src/content/engine/2.1/build.mdtext @@ -2,9 +2,9 @@ Title: Apache Velocity Engine - Building ## Installation -Velocity runs on a variety of platforms that have installed the Java Virtual Machine. A Java Development Kit version 1.7+ is required to compile Velocity from its source code (as it is to run it). +Velocity runs on a variety of platforms that have installed the Java Virtual Machine. A Java Development Kit version 1.8+ is required to compile Velocity from its source code (as it is to run it). -Everything required to build Velocity comes with the distribution, which can be obtained from [Subversion](http://svn.apache.org/repos/asf/velocity/engine/) or from the [main distribution](/download.cgi#engine). However, you will need to install [Maven](http://maven.apache.org/) to build the Velocity sources. +Everything required to build Velocity comes with the distribution, which can be obtained from [Apache git](https://gitbox.apache.org/repos/asf/velocity-engine.git), [github](https://github.com/apache/velocity-engine.git) (handy to submit pull requests) or from the [main distribution](/download.cgi#engine). However, you will need to install [Maven](http://maven.apache.org/) to build the Velocity sources. [Maven](http://maven.apache.org/) is also an Apache project. To build Apache Velocity, you need at least Version 3.0.5 of Apache Maven. @@ -14,16 +14,18 @@ To build Velocity we require [Maven](http://maven.apache.org/) version 3.0.5 or ## Building from Sources -In each case below, it is assumed that you were successful in [checking out the sources from Subversion](/download.cgi#source-code-repository): +In each case below, it is assumed that you were successful in [checking out the sources from github](/download.cgi#source-code-repository): :::shell - svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - cd velocity + git clone https://github.com/apache/velocity-engine.git velocity-engine + cd velocity-engine mvn install -Executing this script will create a **target** directory within the velocity directory. Each subdirectory containing a module of Velocity will contain a "target" directory too, containing all built jars. +Executing this script will create a **target** directory within the velocity-engine directory. Each subdirectory containing a module of Velocity will contain a "target" directory too, containing all built jars. -Refer to Maven documentation for all phases you can invoke. +After a successful build with the above command, your Velocity build will be available in your local Maven repository. + +Refer to Maven documentation for alternate commands you can invoke. If you find a problem, do not hesitate to ask the Velocity community -via our [mail lists](/contact.html). +via our [mailing lists](/contact.html). diff --git a/src/content/engine/2.1/developer-guide.mdtext b/src/content/engine/2.1/developer-guide.mdtext index 8a79d3c..0880959 100644 --- a/src/content/engine/2.1/developer-guide.mdtext +++ b/src/content/engine/2.1/developer-guide.mdtext @@ -19,7 +19,7 @@ We suggest you read this article on [getting started with web applications](weba You can download the latest release version of the [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the latest source, you can do so via the git source control system and/or our github.com mirror. You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). @@ -216,7 +216,8 @@ That's really all there is to basic context operations. For more information, se ### Support for Iterative Objects for #foreach() -As a programmer, you have great freedom in the objects that you put into the context. But as with most freedoms, this one comes with a little bit of responsibility, so understand what Velocity supports, and any issues that may arise. Velocity supports serveral types of collection types suitable for use in the VTL `#foreach()` directive. +As a programmer, you have great freedom in the objects that you put into the context. But as with most freedoms, this one comes with a little bit of responsibility, so understand what Velocity supports, and any issues that may arise. Velocity supports serveral types of collection types suitable for use in the VTL `#foreach()` directive: + + `Object []` Regular object array, not much needs to be said here. Velocity will internally wrap your array in a class that provides an Iterator interface, but that shouldn't concern you as the programmer, or the template author. Of more interest, is the fact that Velocity will now allow template authors to treat arrays as fixed-length lists. This means they may call methods like `size()`, `isEmpty()` and `get(int)` as well as the `empty` property on both arrays and standard java.uti [...] + `java.util.Collection` Velocity will use the `iterator()` method to get an Iterator to use in the loop, so if you are implementing a Collection interface on your object, please ensure that `iterator()` returns a working Iterator. + `java.util.Map ` Here, Velocity depends upon the `values()` method of the interface to get a `Collection` interface, on which `iterator()` is called to retrieve an Iterator for the loop. @@ -844,7 +845,7 @@ There are currently four kinds of resource loaders that are included with Veloci The [VelocityTools](/tools/devel/) project also defines a [WebappResourceLoader](/tools/devel/apidocs/org/apache/velocity/tools/view/WebappResourceLoader.html), active by default, which maps '/' to the root of the webapp. -Advanced users may also want to replace the Resource Manager or the Resource Cache: the Resource Manager is the main part of the resource (template and static content) management system, and is responsible for taking application requests for templates, finding them in the available resource loaders, and then optionally caching the parsed template. The Resource Cache is the mechanism that the Resource Manager uses to cache templates for quick reuse. While the default versions of these two [...] +Advanced users may also want to replace the Resource Manager or the Resource Cache: the Resource Manager is the main part of the resource (template and static content) management system, and is responsible for taking application requests for templates, finding them in the available resource loaders, and then optionally caching the parsed template. The Resource Cache is the mechanism that the Resource Manager uses to cache templates for quick reuse. While the default versions of these two [...] ## Application Attributes diff --git a/src/content/engine/2.1/index.mdtext b/src/content/engine/2.1/index.mdtext index f0c87e0..b5a6298 100644 --- a/src/content/engine/2.1/index.mdtext +++ b/src/content/engine/2.1/index.mdtext @@ -10,21 +10,15 @@ You can check the [Velocity Template Language (VTL) reference](vtl-reference.htm The current stable release version is version 2.2. -The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi).. +The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi). -The Velocity jars are also available through the [central Maven repository](https://search.maven.org/artifact/org.apache.velocity/velocity-engine-core/2.1/jar). +The Velocity jars are also available through the [central Maven repository](https://search.maven.org/artifact/org.apache.velocity/velocity-engine-core/2.2/jar). Older releases are archived at the [Apache Velocity archives](http://archive.apache.org/dist/velocity/engine/). ## Where do I get nightly snapshots? -<!-- -Nightly snapshots of the Velocity subversion source code tree can be found on our [nightly snapshot site(http://vc.apache.org/snapshots/velocity/). - -If you are willing to risk getting dirty, we invite you to try the nightly snapshot to see the current state of affairs. (and help out!) [Public subversion access](http://www.apache.org/dev/version-control.html) is also available. ---> - -Nightly snapshots aren't currently activated, but you can build the latest version using the [Public subversion access](http://www.apache.org/dev/version-control.html), and you can find the latest published snapshot on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). +Nightly snapshots aren't currently activated, but you can [build the latest version](build.html), and you can find the latest published snapshot on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). **Caveat!** These snapshots are generated automatically from the project source code repository. As this is our live development workspace, there are no guarantees as to what you will find there, although we do our best to maintain a buildable source tree. If you are looking for the stable supported release, please use the current release of Velocity. @@ -36,5 +30,5 @@ The Velocity project appreciates any contributions, including documentation help + Report bugs, ask questions, and help new users on the [Velocity mailing lists](http://velocity.apache.org/contact.html). + There's a list of issues waiting to be addressed in [our bug tracker](https://issues.apache.org/jira/browse/VELOCITY). -+ [Our wiki](http://wiki.apache.org/velocity/velocity) has a large collection of community written content. Add your own article or contribute to the FAQ! -+ Read-only access to the Subversion repository is available both [online](http://svn.apache.org/repos/asf/velocity/engine/trunk/) and with a [Subversion client](http://www.apache.org/dev/version-control.html). ++ [Our wiki](https://wiki.apache.org/velocity/velocity) has a large collection of community written content. Add your own article or contribute to the FAQ! ++ Read-only access to the git repository is available both [online](https://github.com/apache/velocity-engine) and with a [Git client](https://www.apache.org/dev/version-control.html). diff --git a/src/content/engine/2.1/source-repository.mdtext b/src/content/engine/2.1/source-repository.mdtext index a5ec58f..065bb6b 100644 --- a/src/content/engine/2.1/source-repository.mdtext +++ b/src/content/engine/2.1/source-repository.mdtext @@ -1,49 +1,12 @@ ## Overview -This project uses [Subversion](http://subversion.tigris.org) to manage its source code. Instructions on Subversion use can be found at [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/). +This project uses [Git](https://git-scm.com/) to manage its source code. Instructions on how to use git can be found at [Git documentation](https://git-scm.com/doc). ## Web Access -The following is a link to the online source repository. - -[http://svn.apache.org/viewvc/velocity/engine/trunk](http://svn.apache.org/viewvc/velocity/engine/trunk) +Apache gitbox repository: [https://gitbox.apache.org/repos/asf?p=velocity-engine.git](https://gitbox.apache.org/repos/asf?p=velocity-engine.git) {.frame} -## Anonymous access - -The source can be checked out anonymously from SVN with this command: - - :::shell - $ svn checkout http://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -## Developer access - -Everyone can access the Subversion repository via HTTP, but Committers must checkout the Subversion repository via HTTPS. - - :::shell - $ svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password) - - :::shell - $ svn commit --username your-username -m "A message" - -## Access from behind a firewall - -For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion repository, you can try to access it via the developer connection: - - :::shell - $ svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -## Access through a proxy - -The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The file's location depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.) - -There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created. - -Example: Edit the 'servers' file and add something like: +Github mirror: [https://github.com/apache/velocity-engine](https://github.com/apache/velocity-engine). +{.frame} - :::properties - [global] - http-proxy-host = your.proxy.name - http-proxy-port = 3128 diff --git a/src/content/engine/2.2/build.mdtext b/src/content/engine/2.2/build.mdtext index b38016e..cc925fa 100644 --- a/src/content/engine/2.2/build.mdtext +++ b/src/content/engine/2.2/build.mdtext @@ -4,7 +4,7 @@ Title: Apache Velocity Engine - Building Velocity runs on a variety of platforms that have installed the Java Virtual Machine. A Java Development Kit version 1.8+ is required to compile Velocity from its source code (as it is to run it). -Everything required to build Velocity comes with the distribution, which can be obtained from [Subversion](http://svn.apache.org/repos/asf/velocity/engine/) or from the [main distribution](/download.cgi#engine). However, you will need to install [Maven](http://maven.apache.org/) to build the Velocity sources. +Everything required to build Velocity comes with the distribution, which can be obtained from [Apache git](https://gitbox.apache.org/repos/asf/velocity-engine.git), [github](https://github.com/apache/velocity-engine.git) (handy to submit pull requests) or from the [main distribution](/download.cgi#engine). However, you will need to install [Maven](http://maven.apache.org/) to build the Velocity sources. [Maven](http://maven.apache.org/) is also an Apache project. To build Apache Velocity, you need at least Version 3.0.5 of Apache Maven. @@ -14,18 +14,18 @@ To build Velocity we require [Maven](http://maven.apache.org/) version 3.0.5 or ## Building from Sources -In each case below, it is assumed that you were successful in [checking out the sources from Subversion](/download.cgi#source-code-repository): +In each case below, it is assumed that you were successful in [checking out the sources from github](/download.cgi#source-code-repository): :::shell - svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - cd velocity + git clone https://github.com/apache/velocity-engine.git velocity-engine + cd velocity-engine mvn install -Executing this script will create a **target** directory within the velocity directory. Each subdirectory containing a module of Velocity will contain a "target" directory too, containing all built jars. +Executing this script will create a **target** directory within the velocity-engine directory. Each subdirectory containing a module of Velocity will contain a "target" directory too, containing all built jars. After a successful build with the above command, your Velocity build will be available in your local Maven repository. Refer to Maven documentation for alternate commands you can invoke. If you find a problem, do not hesitate to ask the Velocity community -via our [email lists](/contact.html). +via our [mailing lists](/contact.html). diff --git a/src/content/engine/2.2/developer-guide.mdtext b/src/content/engine/2.2/developer-guide.mdtext index 4cf86b7..22e7ac8 100644 --- a/src/content/engine/2.2/developer-guide.mdtext +++ b/src/content/engine/2.2/developer-guide.mdtext @@ -19,7 +19,7 @@ We suggest you read this article on [getting started with web applications](weba You can download the latest release version of the [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the latest source, you can do so via the git source control system and/or our github.com mirror. You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). diff --git a/src/content/engine/2.2/index.mdtext b/src/content/engine/2.2/index.mdtext index 7896e97..b5a6298 100644 --- a/src/content/engine/2.2/index.mdtext +++ b/src/content/engine/2.2/index.mdtext @@ -10,7 +10,7 @@ You can check the [Velocity Template Language (VTL) reference](vtl-reference.htm The current stable release version is version 2.2. -The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi).. +The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi). The Velocity jars are also available through the [central Maven repository](https://search.maven.org/artifact/org.apache.velocity/velocity-engine-core/2.2/jar). @@ -18,13 +18,7 @@ Older releases are archived at the [Apache Velocity archives](http://archive.apa ## Where do I get nightly snapshots? -<!-- -Nightly snapshots of the Velocity subversion source code tree can be found on our [nightly snapshot site(http://vc.apache.org/snapshots/velocity/). - -If you are willing to risk getting dirty, we invite you to try the nightly snapshot to see the current state of affairs. (and help out!) [Public subversion access](http://www.apache.org/dev/version-control.html) is also available. ---> - -Nightly snapshots aren't currently activated, but you can build the latest version using the [Public subversion access](http://www.apache.org/dev/version-control.html), and you can find the latest published snapshot on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). +Nightly snapshots aren't currently activated, but you can [build the latest version](build.html), and you can find the latest published snapshot on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). **Caveat!** These snapshots are generated automatically from the project source code repository. As this is our live development workspace, there are no guarantees as to what you will find there, although we do our best to maintain a buildable source tree. If you are looking for the stable supported release, please use the current release of Velocity. @@ -36,5 +30,5 @@ The Velocity project appreciates any contributions, including documentation help + Report bugs, ask questions, and help new users on the [Velocity mailing lists](http://velocity.apache.org/contact.html). + There's a list of issues waiting to be addressed in [our bug tracker](https://issues.apache.org/jira/browse/VELOCITY). -+ [Our wiki](http://wiki.apache.org/velocity/velocity) has a large collection of community written content. Add your own article or contribute to the FAQ! -+ Read-only access to the Subversion repository is available both [online](http://svn.apache.org/repos/asf/velocity/engine/trunk/) and with a [Subversion client](http://www.apache.org/dev/version-control.html). ++ [Our wiki](https://wiki.apache.org/velocity/velocity) has a large collection of community written content. Add your own article or contribute to the FAQ! ++ Read-only access to the git repository is available both [online](https://github.com/apache/velocity-engine) and with a [Git client](https://www.apache.org/dev/version-control.html). diff --git a/src/content/engine/2.2/source-repository.mdtext b/src/content/engine/2.2/source-repository.mdtext index a5ec58f..065bb6b 100644 --- a/src/content/engine/2.2/source-repository.mdtext +++ b/src/content/engine/2.2/source-repository.mdtext @@ -1,49 +1,12 @@ ## Overview -This project uses [Subversion](http://subversion.tigris.org) to manage its source code. Instructions on Subversion use can be found at [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/). +This project uses [Git](https://git-scm.com/) to manage its source code. Instructions on how to use git can be found at [Git documentation](https://git-scm.com/doc). ## Web Access -The following is a link to the online source repository. - -[http://svn.apache.org/viewvc/velocity/engine/trunk](http://svn.apache.org/viewvc/velocity/engine/trunk) +Apache gitbox repository: [https://gitbox.apache.org/repos/asf?p=velocity-engine.git](https://gitbox.apache.org/repos/asf?p=velocity-engine.git) {.frame} -## Anonymous access - -The source can be checked out anonymously from SVN with this command: - - :::shell - $ svn checkout http://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -## Developer access - -Everyone can access the Subversion repository via HTTP, but Committers must checkout the Subversion repository via HTTPS. - - :::shell - $ svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password) - - :::shell - $ svn commit --username your-username -m "A message" - -## Access from behind a firewall - -For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion repository, you can try to access it via the developer connection: - - :::shell - $ svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -## Access through a proxy - -The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The file's location depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.) - -There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created. - -Example: Edit the 'servers' file and add something like: +Github mirror: [https://github.com/apache/velocity-engine](https://github.com/apache/velocity-engine). +{.frame} - :::properties - [global] - http-proxy-host = your.proxy.name - http-proxy-port = 3128 diff --git a/src/content/engine/devel/build.mdtext b/src/content/engine/devel/build.mdtext index b38016e..cc925fa 100644 --- a/src/content/engine/devel/build.mdtext +++ b/src/content/engine/devel/build.mdtext @@ -4,7 +4,7 @@ Title: Apache Velocity Engine - Building Velocity runs on a variety of platforms that have installed the Java Virtual Machine. A Java Development Kit version 1.8+ is required to compile Velocity from its source code (as it is to run it). -Everything required to build Velocity comes with the distribution, which can be obtained from [Subversion](http://svn.apache.org/repos/asf/velocity/engine/) or from the [main distribution](/download.cgi#engine). However, you will need to install [Maven](http://maven.apache.org/) to build the Velocity sources. +Everything required to build Velocity comes with the distribution, which can be obtained from [Apache git](https://gitbox.apache.org/repos/asf/velocity-engine.git), [github](https://github.com/apache/velocity-engine.git) (handy to submit pull requests) or from the [main distribution](/download.cgi#engine). However, you will need to install [Maven](http://maven.apache.org/) to build the Velocity sources. [Maven](http://maven.apache.org/) is also an Apache project. To build Apache Velocity, you need at least Version 3.0.5 of Apache Maven. @@ -14,18 +14,18 @@ To build Velocity we require [Maven](http://maven.apache.org/) version 3.0.5 or ## Building from Sources -In each case below, it is assumed that you were successful in [checking out the sources from Subversion](/download.cgi#source-code-repository): +In each case below, it is assumed that you were successful in [checking out the sources from github](/download.cgi#source-code-repository): :::shell - svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - cd velocity + git clone https://github.com/apache/velocity-engine.git velocity-engine + cd velocity-engine mvn install -Executing this script will create a **target** directory within the velocity directory. Each subdirectory containing a module of Velocity will contain a "target" directory too, containing all built jars. +Executing this script will create a **target** directory within the velocity-engine directory. Each subdirectory containing a module of Velocity will contain a "target" directory too, containing all built jars. After a successful build with the above command, your Velocity build will be available in your local Maven repository. Refer to Maven documentation for alternate commands you can invoke. If you find a problem, do not hesitate to ask the Velocity community -via our [email lists](/contact.html). +via our [mailing lists](/contact.html). diff --git a/src/content/engine/devel/developer-guide.mdtext b/src/content/engine/devel/developer-guide.mdtext index 2a87a33..85f616f 100644 --- a/src/content/engine/devel/developer-guide.mdtext +++ b/src/content/engine/devel/developer-guide.mdtext @@ -19,7 +19,7 @@ We suggest you read this article on [getting started with web applications](weba You can download the latest release version of the [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the latest source, you can do so via the git source control system and/or our github.com mirror. You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). diff --git a/src/content/engine/devel/getting-started.mdtext b/src/content/engine/devel/getting-started.mdtext index bf7df8a..c5a9398 100644 --- a/src/content/engine/devel/getting-started.mdtext +++ b/src/content/engine/devel/getting-started.mdtext @@ -15,7 +15,7 @@ The best place to start is with the examples provided in the distribution, and w You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the [latest source](source-repository.html), you can do so via the git source control system. You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). diff --git a/src/content/engine/devel/index.mdtext b/src/content/engine/devel/index.mdtext index f3337e4..b5a6298 100644 --- a/src/content/engine/devel/index.mdtext +++ b/src/content/engine/devel/index.mdtext @@ -8,9 +8,9 @@ You can check the [Velocity Template Language (VTL) reference](vtl-reference.htm ## Where do I get releases? -The current stable release version is version 1.7. +The current stable release version is version 2.2. -The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi).. +The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi). The Velocity jars are also available through the [central Maven repository](https://search.maven.org/artifact/org.apache.velocity/velocity-engine-core/2.2/jar). @@ -18,13 +18,7 @@ Older releases are archived at the [Apache Velocity archives](http://archive.apa ## Where do I get nightly snapshots? -<!-- -Nightly snapshots of the Velocity subversion source code tree can be found on our [nightly snapshot site(http://vc.apache.org/snapshots/velocity/). - -If you are willing to risk getting dirty, we invite you to try the nightly snapshot to see the current state of affairs. (and help out!) [Public subversion access](http://www.apache.org/dev/version-control.html) is also available. ---> - -Nightly snapshots aren't currently activated, but you can build the latest version using the [Public subversion access](http://www.apache.org/dev/version-control.html), and you can find the latest published snapshot on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). +Nightly snapshots aren't currently activated, but you can [build the latest version](build.html), and you can find the latest published snapshot on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). **Caveat!** These snapshots are generated automatically from the project source code repository. As this is our live development workspace, there are no guarantees as to what you will find there, although we do our best to maintain a buildable source tree. If you are looking for the stable supported release, please use the current release of Velocity. @@ -36,5 +30,5 @@ The Velocity project appreciates any contributions, including documentation help + Report bugs, ask questions, and help new users on the [Velocity mailing lists](http://velocity.apache.org/contact.html). + There's a list of issues waiting to be addressed in [our bug tracker](https://issues.apache.org/jira/browse/VELOCITY). -+ [Our wiki](http://wiki.apache.org/velocity/velocity) has a large collection of community written content. Add your own article or contribute to the FAQ! -+ Read-only access to the Subversion repository is available both [online](http://svn.apache.org/repos/asf/velocity/engine/trunk/) and with a [Subversion client](http://www.apache.org/dev/version-control.html). ++ [Our wiki](https://wiki.apache.org/velocity/velocity) has a large collection of community written content. Add your own article or contribute to the FAQ! ++ Read-only access to the git repository is available both [online](https://github.com/apache/velocity-engine) and with a [Git client](https://www.apache.org/dev/version-control.html). diff --git a/src/content/engine/devel/source-repository.mdtext b/src/content/engine/devel/source-repository.mdtext index a5ec58f..065bb6b 100644 --- a/src/content/engine/devel/source-repository.mdtext +++ b/src/content/engine/devel/source-repository.mdtext @@ -1,49 +1,12 @@ ## Overview -This project uses [Subversion](http://subversion.tigris.org) to manage its source code. Instructions on Subversion use can be found at [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/). +This project uses [Git](https://git-scm.com/) to manage its source code. Instructions on how to use git can be found at [Git documentation](https://git-scm.com/doc). ## Web Access -The following is a link to the online source repository. - -[http://svn.apache.org/viewvc/velocity/engine/trunk](http://svn.apache.org/viewvc/velocity/engine/trunk) +Apache gitbox repository: [https://gitbox.apache.org/repos/asf?p=velocity-engine.git](https://gitbox.apache.org/repos/asf?p=velocity-engine.git) {.frame} -## Anonymous access - -The source can be checked out anonymously from SVN with this command: - - :::shell - $ svn checkout http://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -## Developer access - -Everyone can access the Subversion repository via HTTP, but Committers must checkout the Subversion repository via HTTPS. - - :::shell - $ svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -To commit changes to the repository, execute the following command to commit your changes (svn will prompt you for your password) - - :::shell - $ svn commit --username your-username -m "A message" - -## Access from behind a firewall - -For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion repository, you can try to access it via the developer connection: - - :::shell - $ svn checkout https://svn.apache.org/repos/asf/velocity/engine/trunk velocity - -## Access through a proxy - -The Subversion client can go through a proxy, if you configure it to do so. First, edit your "servers" configuration file to indicate which proxy to use. The file's location depends on your operating system. On Linux or Unix it is located in the directory "~/.subversion". On Windows it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a hidden directory.) - -There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion client and run any command; this will cause the configuration directory and template files to be created. - -Example: Edit the 'servers' file and add something like: +Github mirror: [https://github.com/apache/velocity-engine](https://github.com/apache/velocity-engine). +{.frame} - :::properties - [global] - http-proxy-host = your.proxy.name - http-proxy-port = 3128
