From 243cd8d1d5aa341b8344ebbb23b3dca00bf9373e Mon Sep 17 00:00:00 2001 From: crossley Date: Sat, 6 Sep 2003 08:26:54 +0000 Subject: [PATCH] Add some more procedure notes. git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@226108 13f79535-47bb-0310-9956-ffa450edef68 --- .../content/xdocs/howto-forrest.xml | 50 +++++++++++++------ 1 file changed, 35 insertions(+), 15 deletions(-) diff --git a/src/documentation/content/xdocs/howto-forrest.xml b/src/documentation/content/xdocs/howto-forrest.xml index a22348e..c51b271 100644 --- a/src/documentation/content/xdocs/howto-forrest.xml +++ b/src/documentation/content/xdocs/howto-forrest.xml @@ -1,5 +1,5 @@ - +
How to produce xml-commons website with Forrest @@ -8,24 +8,24 @@
-
+
Overview -

-This is the procedure that i followed to build the initial xml-commons -website with Forrest. -

+

+ This is the procedure for building the initial xml-commons website + with Forrest. +

-
+
Install Forrest on localhost

- Followed the document: - Using + Follow the document: + Using Forrest

-
+
Seed the new website

This only needed to be done to start and it is done now and committed @@ -38,15 +38,16 @@ vi src/documentation/skinconf.xml ]]>

-
+
Edit the content +

The xdocs source are now ready for anyone to enhance the content.

-
+
Build it and view it +

For better turnaround when developing docs, you can do + 'forrest' which just validates and builds the docs. + If you want to only validate the xdocs then do + 'forrest validate-xdocs'. You can get even faster + turnaround with the targets 'forrest run' and + 'forrest backcopy' (beware with that) to run a + live forrest webapp. + Do 'forrest -projecthelp' for more tips. Anyway, see the + Using Forrest + document. +

-
+
+ Updating the website +

Copy everything in ./build/site over to the xml-site + repository at xml-site/targets/commons and commit. +

+
+ +
Other notes

A project sitemap has been added at src/documentation/sitemap.xmap of which we only use a small -portion. This portion has been marked with comments. +portion. This portion has been marked with comments to enable easier sync +with Forrest releases.

@@ -70,7 +90,7 @@ If that is different on your system, then tweak the sitemap.xmap to suit.

-
+
Still to do
  • Ask the 'forrestbot' to build the xml-commons site.