Date: 2004-11-24T21:16:40 Editor: DavidCrossley <[EMAIL PROTECTED]> Wiki: Cocoon Wiki Page: CocoonWebsiteUpdate URL: http://wiki.apache.org/cocoon/CocoonWebsiteUpdate
update website instructions Change Log: ------------------------------------------------------------------------------ @@ -5,40 +5,50 @@ == See also == * CocoonReleaseHowTo ----- + = HOW TO UPDATE AN APACHE COCOON WEBSITE = Here are the steps to do this: == A) Checkout Cocoon SVN == -Checkout one of the Cocoon SVN modules: + +Checkout the SVN module for the branch that you wish to update: * cocoon-1 * cocoon-2.0 * cocoon-2_1_X - * ... + If you have checkout already, just update it. == B) Checkout Cocoon Site SVN == + Checkout cocoon/site SVN module. If you have checkout already, just update it. This repository holds the generated docs for both the top-level website and for each set of version-specific docs. It also holds the source xdocs and the Forrest config files for the top-level website. Note: cocoon-site is more than 60 Mb. You can checkout only part of it, say, for Cocoon 2.1, cocoon-site/site/2.1 (35Mb) == C) Generate site == -This is done simply by issuing 'build docs' command in the shell in cocoon-2_1_X root directory. After generation is complete, site should be ready at the ../cocoon-site/x.y/ directory. For the top-level website just do the command 'forrest' in the top-level cocoon-site directory. + +For the current release branch, e.g. 2.1, this is done by issuing 'build docs' command in the shell in cocoon-2_1_X root directory. After generation is complete, the site will be ready at the build/cocoon-2.1.7-dev/site/ directory. + +For the top-level website, just do the command 'forrest' in the top-level cocoon-site directory. +After generation is complete, the site will be ready at the build/tmp/context/site/ directory. + +View the generated docs to be sure that everything is as you would expect. + === Forrest notes === - 1. Use Forrest-0.5.1 (available from the [http://forrest.apache.org/mirrors.cgi#archive Download Archive] and follow its instructions to set FORREST_HOME and PATH environment variables. - 1. Do not use Forrest-0.6 (the recent release) as this still needs some changes for Cocoon's Forrest config files. - 1. Cocoon's 'build docs' command will call Forrest internally. Forrest's location is determined by the $FORREST_HOME environment variable and defaults to '../xml-forrest/build/dist/shbat/' - 1. Out the box, Forrest will not render PNG images in PDFs. To do this, you need to - * Download Jimi from [http://java.sun.com/products/jimi/ Sun] - * Copy the !JimiProClasses.zip file to $FORREST_HOME/lib/optional/jimi-1.0.jar - * Rebuild Forrest (cd xml-forrest; ./build.sh clean; ./build.sh) -We should soon have the [http://forrestbot.cocoondev.org Forrestbot] facility running, which should make all of this vastly simpler. + + * Use Forrest-0.5.1 (available from the [http://forrest.apache.org/mirrors.cgi#archive Download Archive] and follow its instructions to set FORREST_HOME and PATH environment variables. + * Do not use Forrest-0.6 (the recent release) as this still needs some changes for Cocoon's Forrest config files. + * Cocoon's 'build docs' command will call Forrest internally. Forrest's location is determined by the $FORREST_HOME environment variable and defaults to '../xml-forrest/build/dist/shbat/' + * Out the box, Forrest will not render PNG images in PDFs (due to license restrictions on Jimi). You need to download Jimi from [http://java.sun.com/products/jimi/ Sun]. Copy the !JimiProClasses.zip file to $FORREST_HOME/lib/optional/jimi-1.0.jar and rebuild Forrest (cd xml-forrest; ./build.sh clean; ./build.sh) + +We should soon have the [http://forrest.apache.org/ Forrestbot] facility running, which should make all of this vastly simpler. == D) Upload site into SVN == -Ensure that your cocoon-site is up-to-date (svn update). Copy the generated files from ./build/site/* to the relevant directory under cocoon-site/site/), remove removed files, add added files, svn propset, etc. Then, commit results into cocoon-site. + +Ensure that your cocoon-site is up-to-date (svn update). Copy the generated files to the relevant directory under cocoon-site/site/ and then remove removed files, add added files, svn propset, etc. Then commit results into cocoon-site. == E) Update site on the server == + Steps are: * ssh into www.apache.org (or cvs.apache.org - same machine) * Check your environment: make sure your umask is set to 0002 ('umask 0002' in ~/.profile, or use the "umask" command) @@ -48,8 +58,7 @@ == Done! == ----- -Other notes:[[BR]] +Other notes: * There is a .htaccess file to redirect the old URLs from xml.apache.org/cocoon/* to the current distribution, e.g. /2.1/ ... so when v2.2 comes you need to edit cvs xml-site/targets/cocoon/.htaccess and manually at /www/xml.apache.org/cocoon/.htaccess - * The files that create the dist/cocoon/ directory are not all under source control (ToDo: they should be), so edit those files in place at /www/www.apache.org/dist/cocoon/*.html (don't forget the .htaccess files). Other files like "mirror.html" are under source control, so edit them in the cocoon-site module, then 'ssh cvs.apache.org; cd /www/cocoon.apache.org/; svn update mirror.html'. + * The files that create the dist/cocoon/ directory are not all under source control (Todo: they should be), so edit those files in place at /www/www.apache.org/dist/cocoon/*.html (don't forget the .htaccess files). Other files like "mirror.html" are under source control, so edit them in the cocoon-site module, then 'ssh cvs.apache.org; cd /www/cocoon.apache.org/; svn update mirror.html'.
