You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by le...@apache.org on 2003/01/05 16:29:29 UTC
cvs commit: jakarta-avalon-excalibur/fortress/src/xdocs getting-started.xml index.xml menu.xml
leosimons 2003/01/05 07:29:29
Modified: fortress/src/xdocs index.xml menu.xml
Added: fortress/src/xdocs getting-started.xml
Log:
adding _very_ basic getting started documentation for fortress by pointing people at the examples, also updating the index page to refer to existing info
Revision Changes Path
1.6 +40 -5 jakarta-avalon-excalibur/fortress/src/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/xdocs/index.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- index.xml 26 Jul 2002 16:12:44 -0000 1.5
+++ index.xml 5 Jan 2003 15:29:29 -0000 1.6
@@ -4,7 +4,7 @@
<header>
<title>Excalibur Fortress - Overview</title>
<authors>
- <person name="Berin Loritsch" email="bloritsch@apache.org"/>
+ <person name="The Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
</authors>
</header>
<body>
@@ -18,10 +18,45 @@
</warn>
<p>
Fortress contains a framework to help you create your own
- containers. It boasts asynchronous management of your
- component instances, high scalability, and easier
- maintenance of your code.
+ avalon containers. It boasts asynchronous management of your
+ component instances, high scalability, easier maintenance of
+ your code, and easy embedding into various environments like
+ servlet engines.
</p>
+ </s1>
+ <s1 title="downloads">
+ <p>
+ When fortress is released, binaries will be made available. For
+ now, you can try downloading a nightly build from
+ <link href="http://cvs.apache.org/builds/jakarta-avalon/nightly/">here</link>.
+ </p>
+ <p>
+ Other than that, the only way to get fortress is by using cvs.
+ </p>
+ </s1>
+ <s1 title="available documentation">
+ <ul>
+ <li>The primary source of documentation is the fortress website, available
+ at
+ <link href="http://jakarta.apache.org/avalon/fortress/">http://jakarta.apache.org/avalon/fortress/</link>.</li>
+ <li>There is some material relating to fortress in the experimental
+ <link href="http://nagoya.apache.org/wiki/">ApacheWiki</link>, right
+ <link href="http://nagoya.apache.org/wiki/apachewiki.cgi?AvalonFortress">here</link>.
+ One of the things you can find there is the
+ <link href="http://nagoya.apache.org/wiki/apachewiki.cgi?AvalonFortressFAQ">FAQ</link>.</li>
+ <li>You will probably want to check out the examples that come with fortress;
+ they're located in the examples/ dir in cvs, and nightly builds are also
+ made available.</li>
+ <li>For general information about the avalon project, you will want to read the
+ <link href="http://jakarta.apache.org/avalon/framework/">Avalon Framework Documentation</link>.
+ <link href="http://jakarta.apache.org/avalon/developing/">Developing with Avalon</link> is a
+ terribly useful resource as well.</li>
+ <li>We strive to completely javadoc all source code; the apidocs are available
+ <link href="api/">online</link>.</li>
+ <li>If, after reading all that, you still have unanswered questions, the
+ <link href="http://jakarta.apache.org/site/mail2.html#Avalon">avalon-user list</link>
+ and its archive can be incredibly useful.</li>
+ </ul>
</s1>
</body>
<footer>
1.3 +22 -19 jakarta-avalon-excalibur/fortress/src/xdocs/menu.xml
Index: menu.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/xdocs/menu.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- menu.xml 22 Sep 2002 08:31:09 -0000 1.2
+++ menu.xml 5 Jan 2003 15:29:29 -0000 1.3
@@ -1,22 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<project href="http://jakarta.apache.org/avalon/excalibur/fortress/" name="Excalibur Fortress">
- <title>Excalibur Fortress</title>
- <body>
- <menu name="Related">
- <item href="http://jakarta.apache.org/avalon/" name="Avalon Home"/>
- <item href="http://jakarta.apache.org/avalon/excalibur/" name="Excalibur Home"/>
- <item href="http://jakarta.apache.org/avalon/phoenix" name="Avalon Phoenix"/>
- <item href="http://jakarta.apache.org/avalon/excalibur/component" name="ECM"/>
- <item href="http://jakarta.apache.org/avalon/excalibur/tweety" name="Tweety"/>
- </menu>
-
- <menu name="Essentials">
- <item href="index.html" name="Overview"/>
- <item href="features.html" name="Features"/>
- <item href="lifecycle-extensions.html" name="Lifecycle Extensions"/>
- <item href="http://jakarta.apache.org/builds/jakarta-avalon-excalibur/release" name="Download"/>
- <item href="api/" name="API Docs"/>
- </menu>
-
- </body>
+ <title>Excalibur Fortress</title>
+ <body>
+ <menu name="Essentials">
+ <item href="index.html" name="Overview"/>
+ <item href="features.html" name="Features"/>
+ <item href="getting-started.html" name="Getting Started"/>
+ <item href="http://jakarta.apache.org/builds/jakarta-avalon-excalibur/release" name="Download"/>
+ </menu>
+
+ <menu name="Related">
+ <item href="http://jakarta.apache.org/avalon/" name="Avalon Home"/>
+ <item href="http://jakarta.apache.org/avalon/excalibur/" name="Excalibur Home"/>
+ <item href="http://jakarta.apache.org/avalon/phoenix" name="Avalon Phoenix"/>
+ <item href="http://jakarta.apache.org/avalon/excalibur/component" name="ECM"/>
+ <item href="http://jakarta.apache.org/avalon/excalibur/tweety" name="Tweety"/>
+ </menu>
+
+ <menu name="Reference">
+ <item href="api/" name="API Docs"/>
+ <item href="lifecycle-extensions.html" name="Lifecycle Extensions"/>
+ </menu>
+ </body>
</project>
1.1 jakarta-avalon-excalibur/fortress/src/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
<?xml version="1.0"?>
<document>
<header>
<title>Excalibur Fortress - Getting Started</title>
<authors>
<person name="The Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
</authors>
</header>
<body>
<s1 title="Introduction">
<p>
This is a brief guide to getting you up and running with fortress.
For complex topics like how to decompose a system into individual
components, Seperation of Concerns, etc, refer to other documentation.
</p>
</s1>
<s1 title="Getting your stuff together">
<ul>
<li>If you haven't already, download and install the latest version
of <link href="http://ant.apache.org/">Apache Ant</link>.</li>
<li>Get and install a CVS client (see
<link href="http://jakarta.apache.org/site/cvsindex.html">here</link>
for information on CVS).</li>
<li>Check out the modules jakarta-avalon, jakarta-avalon-excalibur,
jakarta-avalon-logkit and jakarta-site</li>
<li>Use ant to build the various projects:
<source>
cd $CVSROOT/jakarta-avalon
ant jar
cd $CVSROOT/jakarta-avalon-logkit
ant jar
cd $CVSROOT/jakarta-avalon-excalibur/fortress
ant dist
cd examples
ant
</source>
If something goes wrong, run ant in verbose mode using the -v option and
send the output to the avalon-user mailing list. Someone'll help you out.
</li>
</ul>
<p>Or, if you hate CVS, get a nightly build.</p>
</s1>
<s1 title="Hello, world!">
<p>You just built fortress, its dependencies, and its examples from cvs in
the previous step. This enables you to (finally!) run a HelloWorld demo.
change into the bin directory for the examples and run the
scripts there (runswing.sh is a nice one).</p>
</s1>
<s1 title="Well, duh! So now what?">
<s2 title="Play with the examples">
<p>After looking at the sources to the examples provided and figuring out
what goes on (if you're an IDE person, run the examples in your IDE
debugger! If you develop servlets, be sure to try to get the servlet
example to run), the real cool but also the hard part begins.</p>
</s2>
<s2 title="Converting from ECM">
<p>If you're looking at converting an existing avalonized application that
uses ECM, well, we want to write a tool that does this all but automatically
for you. Not there yet though.</p>
</s2>
<s2 title="Convert a non-avalon application">
<p>The first thing you want to do is to create a fortress instance inside
your applications main loop or bootstrap class. The second thing you want
to do is identify the building blocks of your application, and transform
them into avalon components (by making them passive, and extending the
avalon framework lifecycle interfaces).
Then, create the fortress configuration files to tell it about those new
components, and transfer control over those components from your bootstrap
code to fortress. Done!</p>
<p>Okay, so it may not be so simple as it sounds, but that is the general
idea. Just get started, and come and talk to us on the mailing list when
you get lost.</p>
</s2>
<s2 title="Creating a new application">
<p>Start with the example that fits your enviroment (console, GUI
or embedded), and simply start hacking from there. You'll want to think
about the various tasks your app serves, and how to decompose your app
into components that fit those tasks. The
<link href="http://jakarta.apache.org/avalon/developing">Developing with Avalon</link>
paper talks you through this.</p>
</s2>
</s1>
<s1 title="Mastering Fortress">
<p>
The best way to learn about avalon and its concepts is to build your own
container. Try and plug in your own implementations of the different parts
of fortress, like a different ComponentHandler. Once you get a hang of it,
come and join the avalon folks in their quest for the holy grail of
software architecture!
</p>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2003/01/05 15:29:29 $
</legal>
</footer>
</document>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>