You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by cr...@apache.org on 2002/12/31 09:23:37 UTC
cvs commit: xml-forrest/src/documentation/content/xdocs forrestbot-intro.xml forrestbot.xml index.xml
crossley 2002/12/31 00:23:37
Modified: . status.xml
src/documentation/content/xdocs forrestbot-intro.xml
forrestbot.xml index.xml
Log:
Updated the Forrestbot Introduction, show src/resources/forrestbot/samples
Revision Changes Path
1.86 +4 -0 xml-forrest/status.xml
Index: status.xml
===================================================================
RCS file: /home/cvs/xml-forrest/status.xml,v
retrieving revision 1.85
retrieving revision 1.86
diff -u -r1.85 -r1.86
--- status.xml 28 Dec 2002 15:23:54 -0000 1.85
+++ status.xml 31 Dec 2002 08:23:36 -0000 1.86
@@ -24,6 +24,10 @@
<changes>
<release version="0.3-dev" date="unreleased">
+ <action dev="DC" type="update" context="forrestbot">
+ Updated some documentation, especially
+ <link href="forrestbot-intro.html">Forrestbot Introduction</link>
+ </action>
<action dev="NKB" type="fix" context="shbat">
Now files present in the content dir are correctly linked and
copied verbatim by the CLI. The wellknown files are given with the
1.3 +21 -18 xml-forrest/src/documentation/content/xdocs/forrestbot-intro.xml
Index: forrestbot-intro.xml
===================================================================
RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/forrestbot-intro.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- forrestbot-intro.xml 14 Nov 2002 09:00:54 -0000 1.2
+++ forrestbot-intro.xml 31 Dec 2002 08:23:36 -0000 1.3
@@ -3,9 +3,9 @@
<document>
<header>
- <title>Your Project - getting started with using Forrest</title>
- <subtitle>Overview</subtitle>
- <version>0.1</version>
+ <title>Forrestbot introduction</title>
+ <subtitle>Getting started with using Forrestbot</subtitle>
+ <version>0.2</version>
<authors>
<person name="David Crossley" email="crossley@apache.org"/>
</authors>
@@ -32,18 +32,24 @@
it can be called from cron to automate your website update, it can operate
as a centralised docs-build service for a set of remote projects, it can do
tasks in parallel, and do even more.
+ See some websites that are automatically built with ForrestBot at
+ <link href="http://forrestbot.cocoondev.org/">http://forrestbot.cocoondev.org/</link>
</p>
<p>
This document provides a concise overview of one particular scenario. See
<link href="forrestbot.html">The ForrestBot</link> for details and understand
<link href="forrest-contract.html">Our Contract</link>.
+ We assume that you have built and configured Forrest as described in
+ <link href="your-project.html">Using Forrest</link>.
+ </p>
+ <p>
Please send your feedback to <code>forrest-dev</code> - the ForrestBot
will be enhanced to meet diverse needs.
</p>
<p>
(Building the documentation for the actual Forrest project is a separate
issue. Use
- <code>./build.sh clean docs</code> ... that will provide overview
+ <code>./build.sh site</code> ... that will provide overview
documentation about how Forrest operates and how you can help to improve it.)
</p>
</section>
@@ -62,15 +68,15 @@
<section>
<title>Establish project configuration</title>
- <p>
-<code>cp $FORREST_HOME/forrestbot.conf.xml $PROJECT_HOME/yourproject.conf.xml</code>
- and edit it to replace the <code><![CDATA[<project>]]></code>
+ <p>See the sample configurations at
+ <code>xml-forrest/src/resources/forrestbot/samples/</code>
+ copy one and edit it to replace the <code><![CDATA[<project>]]></code>
definitions with our own, i.e.
</p>
<source><![CDATA[
<project name="yourProject-local">
<prepare>
- <skin name="basic"/>
+ <skin name="forrest-site"/>
</prepare>
<get-src type="local-copy">
<project-dir name="/home/you/yourproject" />
@@ -85,22 +91,19 @@
<section>
<title>Run ForrestBot</title>
- <source>
-[you@localhost] cd $FORREST_HOME
-[you@localhost] ./build.sh clean
-[you@localhost] ./build.sh bot \
--Dbot.forrestbot.xconf=$PROJECT_HOME/yourproject.conf.xml \
--Dtemplate.echo=true
- </source>
+<source><![CDATA[
+[you@locahost]$ cd $PROJECT_HOME
+[you@locahost]$ forrestbot -Dbot.config=<name>
+... where <name> is the pathname to your configuration file.
+]]></source>
</section>
<section>
<title>Next Steps</title>
<p>Some enhancements to your local ForrestBot would be ...</p>
<ul>
- <li>Add your own skin at
- <code>$SRC_DOC/skins/yourproject</code> by copying one of the skins from
- <code>$FORREST_HOME/src/resources/skins</code> (use basic or forrest-site)
+ <li>Add your own skin as described in
+ <link href="your-project.html">Using Forrest</link>.
</li>
<li>Configure another <code><![CDATA[<project>]]></code> to conduct a secure
copy to your public website.
1.5 +18 -16 xml-forrest/src/documentation/content/xdocs/forrestbot.xml
Index: forrestbot.xml
===================================================================
RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/forrestbot.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- forrestbot.xml 24 Dec 2002 02:04:22 -0000 1.4
+++ forrestbot.xml 31 Dec 2002 08:23:36 -0000 1.5
@@ -5,7 +5,7 @@
<title>The ForrestBot</title>
<authors><person name="Marc Portier" email="mpo@outerthought.org"/></authors>
<abstract>This document explains how the Forrest project can be used to
- centrally build the HTML documentation for different projects. It also explains
+ centrally build the documentation for different projects. It also explains
which pieces in the Forrest distribution form this
functionality, and how they could be extended in the future.</abstract>
</header>
@@ -13,7 +13,7 @@
<section>
<title>Foreword</title>
<p>This document explains how the Forrest project can be used to
- centrally build the HTML documentation for different projects.
+ centrally build the documentation for different projects.
It also explains which pieces in the Forrest distribution form this
functionality, and how they could be extended in the future.</p>
<p>See some related documents:</p>
@@ -21,37 +21,39 @@
<li><link href="forrest-contract.html">Our Contract</link>
- explains the rules with which your project should comply
</li>
- <li><link href="your-project.html">Your Project</link>
- - getting started with using Forrest (concise overview of forrestbot)
+ <li><link href="forrestbot-intro.html">Forrestbot introduction</link>
+ - concise overview of Forrestbot
</li>
</ul>
</section>
<section>
- <title>Using the Forrest Bot</title>
+ <title>Using the Forrestbot</title>
<section>
<title>Setting up the centralized service</title>
- <p>Historically the bot has been thought of as a script that regularly
- is executed. The goal being to publish a purely static website that
- near-real-time-like updates to newly available content. </p>
+ <p>The goal is to publish a static website that can be updated
+ in near-real-time to accomodate newly available content. Forrestbot
+ can run on one machine, get content from another machine, and publish
+ to yet another machine.</p>
<p>Running the bot is as easy as calling the following in your shell.
(executed in the root dir of the distribution.)</p>
<source>build bot -Dbot.forrestbot.xconf=myOwn.conf.xml -Dtemplate.echo=[true|false]</source>
<p>It is quite typical to perform this from a shell script that gets
scheduled for execution on a regular basis.</p>
- <p>The actions the bot is going to take are defined in the XML
- file pointed at with the <code>bot.forrestbot.xconf</code> System property. (if
- not specified with <code>-Dbot.forrest.xconf</code> the default config from the
- distribution is taken: <code>./forrestbot.conf.xml</code>) </p>
</section>
<section>
<title>Describing your project to the bot</title>
<fixme author="mpo">There is not yet a DTD for this configuration
file.</fixme>
- <p>The bot's work is defined in an XML configuration file, which
- has one (optional) child-element for setting cross-project defaults followed by
- a list of project-elements that hold the configuration for the various projects
- the bot is going to work on.</p>
+ <p>The actions the bot is going to take are defined in the XML
+ file pointed at with the <code>bot.forrestbot.xconf</code> System
+ property. (if not specified with <code>-Dbot.forrest.xconf</code>
+ then the default config from the
+ distribution is taken: <code>./forrestbot.conf.xml</code>) </p>
+ <p>This configuration file has one (optional) child-element for
+ setting cross-project defaults, followed by a list of
+ project-elements that hold the configuration for the various projects
+ that the bot is going to work on.</p>
<source><![CDATA[<?xml version="1.0"?>
<forrest-config>
<defaults>
1.19 +3 -5 xml-forrest/src/documentation/content/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/index.xml,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- index.xml 11 Dec 2002 11:20:59 -0000 1.18
+++ index.xml 31 Dec 2002 08:23:36 -0000 1.19
@@ -50,11 +50,9 @@
<li>The
<link href="http://xml.apache.org/forrest/">Forrest website</link>
is updated irregularly and manually, while we develop the
- <link href="forrestbot.html">forrestbot</link> facility.
- <!--which produces
- the temporary
- <link href="http://www.outerthought.net/forrest/">automatically generated</link> site.
- -->
+ <link href="forrestbot.html">forrestbot</link> facility
+ which produces the
+ <link href="http://forrestbot.cocoondev.org/">automatically generated</link> site.
</li>
</ul>
</section>