Space: Apache Connectors Framework
(https://cwiki.apache.org/confluence/display/CONNECTORS)
Page: Updating the Website
(https://cwiki.apache.org/confluence/display/CONNECTORS/Updating+the+Website)
Edited by Karl Wright:
---------------------------------------------------------------------
h1. How To Update The ManifoldCF Website
(*NOTE:* _You need committer rights to modify the Website._)
# Install ant.
# Install an svn client, version 1.7 or later.
# Install python 2.7+.
# Make sure you have write permissions on the directory where Apache Forrest
will be checked out and installed, the first time your run Forrest it will
attempt to create a plug-ins directory and download several plug-ins.
# Check out and prepare to build the current trunk version of Apache Forrest:
{code}svn co http://svn.apache.org/repos/asf/forrest/trunk forrest{code} (Or,
if you want to save time, just install Forrest-0.10-dev or above.)
# Change to the main build area: {code}cd forrest/main{code}
# Build forrest: {code}build{code}
# Follow the instructions the build gives you to complete the Forrest
installation
# Checkout the ManifoldCF site code
[https://svn.apache.org/repos/asf/manifoldcf/site/trunk/].
# Change directory to where the site code was checked out.
# "ant make-core-deps" will download the necessary build dependencies.
# "ant build" will build the current site, including the release documentation
from trunk. The generated site will be in ./build/site/.
# Make your desired website changes to the source files in ./src/ and
regenerate the site with ant.
When you are satisfied with your changes, and want to push them out to the main
site mirror, do the following:
# Commit your changes to trunk.
# Regenerate the site using "ant build".
# Check out [https://svn.apache.org/repos/asf/manifoldcf/site/publish/] to the
location of your choice (a new workarea).
# Download the javadoc patch tool from
[http://www.oracle.com/technetwork/java/javase/downloads/java-doc-updater-tool-1955731.html].
# Run the tool as follows: {code}java -jar JavadocUpdaterTool.jar -R
<path>{code}. You will need to run the tool on the "api" subdirectory of every
release that appears under "./build/site/releases" . For example: {code}java
-jar JavadocUpdaterTool.jar -R ./build/site/releases/trunk/api{code}. *IT IS
ESSENTIAL THAT THIS STEP IS DONE.*
# Execute "python scripts/update-site.py". The first argument should be
"./build/site". The second should be the root of the tree you just checked out.
# The site will automatically be exported from
https://svn.apache.org/repos/asf/manifoldcf/site/publish by the standard Apache
svnpubsub process.
Change your notification preferences:
https://cwiki.apache.org/confluence/users/viewnotifications.action
