From 05f00c377d929f3f9445b96e06bc6009481d097e Mon Sep 17 00:00:00 2001 From: Pascal Sancho Date: Fri, 19 Feb 2010 09:11:56 +0000 Subject: [PATCH] doc mgmt page: 2 things: - dual doc is now obsolete (0.20.x vs redesign) - current Forrest is 0.8 git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@911752 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/dev/doc.xml | 26 +++++++++------------ 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/src/documentation/content/xdocs/dev/doc.xml b/src/documentation/content/xdocs/dev/doc.xml index 4fd6bce78..c75994ec1 100644 --- a/src/documentation/content/xdocs/dev/doc.xml +++ b/src/documentation/content/xdocs/dev/doc.xml @@ -29,11 +29,7 @@ Updates should be committed to the repository, then the repository files are used to generate usable output. The remaining discussions on this page assume that the SVN repository is the starting place for processing. The path to the documentation is src/documentation/content/xdocs.

- All documentation is maintained on the trunk. -Although we are currently maintaining two sets of code (trunk and maintenance), there is only one set of documentation. -Most of the user and developer doc is common to the two environments, and differences are highlighted where necessary. -The major exception to this rule is the design doc, which currently exclusively pertains to the trunk (redesign). -Maintenance branch releases either copy the trunk content to the maintenance branch or use the trunk content directly for doc builds. + All documentation is maintained on the trunk.

Basic documents are stored in XML files, and use DTDs provided by Apache Forrest.

@@ -89,10 +85,10 @@ Maintenance branch releases either copy the trunk content to the maintenance bra
ForrestBot "publish" Step-by-Step

- We're using ForrestBot for build and deploy the FOP website. ForrestBot comes with Apache Forrest 0.7. + We're using ForrestBot for build and deploy the FOP website. ForrestBot comes with Apache Forrest 0.8. The root directory of your FOP checkout contains the file "publish.xml" which is an Ant build file that manages the build and the deployment of the FOP website. Please look into this file for - further instructions to set up ForrestBot on your machine. Basically, we're simply running ForrestBot + further instructions to set up ForrestBot on your machine. Basically, we're simply running ForrestBot manually by typing "ant -f publish.xml" once we're happy with our changes to the site. Step-by-step instructions for the deployment process again:

@@ -104,16 +100,16 @@ Maintenance branch releases either copy the trunk content to the maintenance bra
  • Modify the sources of the website and check locally with Forrest (run "forrest run" or just "forrest").
  • - Once you're satisfied, run "ant -f publish.xml" to do a clean build of the website. If the build - runs without problems, the website will be uploaded as a whole using SVN to the + Once you're satisfied, run "ant -f publish.xml" to do a clean build of the website. If the build + runs without problems, the website will be uploaded as a whole using SVN to the website staging directory in SVN.
  • - Then log into people.apache.org using SSH, go to the /www/xmlgraphics.apache.org + Then log into people.apache.org using SSH, go to the /www/xmlgraphics.apache.org directory and run "svn up".
  • - Wait for the next rsync cycle and check your changes in the live site. + Wait for the next rsync cycle and check your changes in the live site. (Sorry, no manual rsync available ATM)
@@ -126,8 +122,8 @@ Maintenance branch releases either copy the trunk content to the maintenance bra Using a Local Forrest

To use a local Forrest (during website development, not for deployment):

    -
  • download latest the Forrest release (currently Forrest 0.7)
    • -
  • set environment variable FORREST_HOME=~/apache-forrest-0.7 where ~ is the directory where Forrest is installed +
  • download latest the Forrest release (currently Forrest 0.8)
    • +
  • set environment variable FORREST_HOME=~/apache-forrest-0.8 where ~ is the directory where Forrest is installed (see http://forrest.apache.org/docs/your-project.html for details)
  • set environment variable PATH=$PATH:$FORREST_HOME/bin
  • cd to your local FOP checkout
    • @@ -135,7 +131,7 @@ Maintenance branch releases either copy the trunk content to the maintenance bra
  • run forrest(.bat), which will build the web-site documents in xml-fop/build/site.
- You can use "forrest run" to start a local web server. That improves development speed as you + You can use "forrest run" to start a local web server. That improves development speed as you can simply refresh in the browser after a change.
@@ -164,7 +160,7 @@ Maintenance branch releases either copy the trunk content to the maintenance bra Please make sure you always have group rw permissions on all files under the /www directory!
- + -- 2.39.5