[site] Run an embedded werserver from the builder script ; cleanup README.md file
diff --git a/README.md b/README.md
index 79f4a9b..94f5433 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-Note: the branch trunk is obsolete. Please use the master branch.
+Note: the branch trunk is obsolete. Please use the main branch.
----
The Apache Velocity Project
@@ -46,7 +46,7 @@
2) Clone the GitHub repository for editing the Markdown files
- git clone --single-branch --branch master git@github.com:[YOUR_GITHUB_ID]/velocity-site.git
+ git clone --single-branch --branch main git@github.com:[YOUR_GITHUB_ID]/velocity-site.git
4) Edit the Markdown files
@@ -59,7 +59,7 @@
6) Check the generated HTML locally
- open $VELOCITY_PARENT_FOLDER/velocity-site-prod/index.html in your favorite web browser
+ open localhost:8000 in your favorite web browser
and navigate around to review your changes
7) Commit your changes
@@ -71,101 +71,6 @@
8) 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):
-
-[...]
-<servers>
- <server>
- <id>velocity.apache.org</id>
- <username>{your apache user id}</username>
- </server>
-</servers>
-[...]
-
- 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
---------------------
diff --git a/builder/bin/builder.sh b/builder/bin/builder.sh
index 91644c0..f069482 100755
--- a/builder/bin/builder.sh
+++ b/builder/bin/builder.sh
@@ -1,6 +1,7 @@
#!/usr/bin/env bash
DOCKER_NAME=velocity-site-builder
+PORT=8000
# exit on failures and undeclared variables, echo commands
set -o errexit
@@ -85,7 +86,7 @@
fi
# do the voodoo
-docker run --rm --name $DOCKER_NAME -u "$(id -u):$(id -g)" --volume="$BASE:/home/velocity" $DOCKER_NAME
+docker run --rm -ti --name $DOCKER_NAME -u "$(id -u):$(id -g)" --volume="$BASE:/home/velocity" --publish 127.0.0.1:$PORT:8000 $DOCKER_NAME
# alternatively, if you need to debug the container (as root), comment the previous command and run instead:
# docker run -it --name $DOCKER_NAME --volume="$BASE:/home/velocity" --entrypoint=/bin/bash velocity-site-builder
diff --git a/builder/src/docker/build.sh b/builder/src/docker/build.sh
index 6f5c543..290d9ca 100755
--- a/builder/src/docker/build.sh
+++ b/builder/src/docker/build.sh
@@ -30,3 +30,9 @@
find $VELOCITY/velocity-site-prod/ -name "*.html" | xargs sed -ri -e "s'<span></span>''g"
+echo Running web server...
+echo Review the changes at http://localhost:8080
+echo Press ctrl-c to exit.
+
+cd $VELOCITY/velocity-site-prod
+python -m SimpleHTTPServer
