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/24 20:39:41 UTC

cvs commit: jakarta-avalon-site/src/documentation/content/xdocs case-studies.xml code-standards.xml cvs.xml features.xml getting-started.xml license.xml mailing-lists.xml mission.xml news.xml book.xml

leosimons    2003/01/24 11:39:40

  Modified:    src/documentation/content/xdocs book.xml
  Added:       src/documentation/content/xdocs case-studies.xml
                        code-standards.xml cvs.xml features.xml
                        getting-started.xml license.xml mailing-lists.xml
                        mission.xml news.xml
  Log:
  more docs. woo-hooh!
  
  Revision  Changes    Path
  1.3       +1 -1      jakarta-avalon-site/src/documentation/content/xdocs/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-site/src/documentation/content/xdocs/book.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- book.xml	24 Jan 2003 16:59:22 -0000	1.2
  +++ book.xml	24 Jan 2003 19:39:40 -0000	1.3
  @@ -40,7 +40,7 @@
     </menu>
     
     <menu label="Development">
  -    <menu-item label="Coding standards" href="coding-standards.html"/>
  +    <menu-item label="Coding standards" href="code-standards.html"/>
       <menu-item label="Get Involved" href="get-involved.html"/>
       <menu-item label="Project Guidelines" href="project/index.html"/>
     </menu>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/case-studies.xml
  
  Index: case-studies.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
  
   <header>
    <title>Avalon Project - Case Studies</title>
    <authors>
      <person name="Robert McIntosh" email="rmcintosh@bull-enterprises.com"/>
    </authors>
   </header>
  
  <body>
  
  <section>
  <title>Phoenix Applications</title>
    <p>There are a number of applications that are designed to run in the Phoenix
    kernel. A list of these can be found <link href="http://jakarta.apache.org/avalon/apps/appselsewhere.html">here</link>.</p>
  </section>
  
  <section>
  <title>Avalon Applications</title>
    <section>
  <title>Cocoon</title>
      <p>Cocoon is the highly successful XML-based web publishing framework
      from the Apache group. Cocoon is a very flexible environment designed for
      high performance and scalability of delivering XML-based content.</p>
      <p>
  <link href="http://xml.apache.org/cocoon">Cocoon project</link>
  </p>
    </section>
    
    <section>
  <title>Applications Sub-Project</title>
      <p>There are a number of applications currently in work in the 
      <link href="http://jakarta.apache.org/avalon/apps/appsincvs.html">Applications</link> sub-project, including
      a RDBMS, FTP server, and XML command server, among others.</p>
    </section>
  </section>
  
  <section>
  <title>Commercial Projects</title>
    <section>
  <title>eQ!(tm)</title>
      <p>A commercial product from Browsersoft, Inc., eQ!(tm) is a business object foundation
       which has recently been refactored and built upon Avalon and utilizes several of 
       Excalibur's components for it's persistence engine, XML-based scripting engine, 
       Struts adapters and other internal usages.</p>
       
       <p>eQ!(tm)'s goal is to provide a foundation upon which to build delivery technology
       neutral business components, and then provide adapters for Struts, Swing, EJB and other
       technologies. eQ!(tm) aims to empower the architect and senior developers while still being
       easy enough for junior developers to use.     
       </p>
       
       <p>For more information visit the <link href="http://www.browsersoft.com/eQ">eQ!(tm) website</link>
  </p>
    </section>
    
  </section>
  
  </body>
  </document>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/code-standards.xml
  
  Index: code-standards.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
  
   <header>
    <title>Avalon Project - Coding Standards</title>
    <authors>
     <person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
    </authors>
   </header>
  
  <body>
  <section>
  <title>Coding Standards</title>
   <p>This document describes a list of coding conventions that are required
   for code submissions to the project. By default, the coding conventions
   for most Open Source Projects should follow the existing coding conventions
   in the code that you are working on. For example, if the bracket is on
   the same line as the if statement, then you should write all your code
   to have that convention.</p>
  
  <p><strong>If you commit code that does not follow these conventions and you
  are caught, you are responsible for also fixing your own code.</strong></p>
  
  <p>Brackets should begin and end on a new line. Examples:</p>
  <source>
  
  if( foo )
  {
      // code here
  }
  
  try
  {
      // code here
  }
  catch( final Exception bar )
  {
      // code here
  }
  finally
  {
      // code here
  }
  
  while( true )
  {
      // code here
  }
  
  </source>
  
  <p>The preference is to include extra spaces between parenthesis and expression.
  For example;
  </p>
  <source>
  
  if( foo )
  
  </source>
  <p>4 spaces. <strong>NO</strong> tabs. Period. We understand that a lot of you like
  to use tabs, but the fact of the matter is that in a distributed development
  environment, when the cvs commit messages get sent to a mailing list, they
  are almost impossible to read if you use tabs.</p>
  
  <p>In Emacs-speak, this translates to the following command:</p>
  
  <source>(setq-default tab-width 4 indent-tabs-mode nil)</source>
  
  <p>In vim, having the following in your .vimrc will help:</p>
  <source>
  set tabstop=4
  set expandtab
  set list
  set listchars=tab:&gt;.
  </source>
  
  <p>Unix linefeeds for all .java source code files. Other platform specific
  files should have the platform specific linefeeds.</p>
  
  <p>Javadoc <strong>SHOULD</strong> exist on all your methods. Also, if you are working
  on existing code and there currently isn't a javadoc for that method/class/variable
  or whatever, then you should contribute and add it. This will improve the
  project as a whole.</p>
  
  <p>The Jakarta Apache/Avalon License <strong>MUST</strong> be placed at the top
  of each and every file.</p>
  
  <p>If you contribute to a file (code or documentation), add yourself to the
  top of the file. For java files the preferred Javadoc format is:</p>
  
  <source>
  @author &lt;a href="mailto:user@domain.com"&gt;John Doe&lt;/a&gt;
  </source>
  
   <p>Indent comments on an 80 column basis and the code on a
   100 column, using a two more indents when a line must be wrapped.</p>
  
  <p>We focus on readability over performance, at least initially. Source code
  optimization is the last thing to be done to increase performance.
  If the code is not performing then it is better to re-engineer it rather
  than to expand loops, take out variable declarations etc. When the code
  is stable and has a well defined purpose and interface it may be appropriate
  to do source code optimization.</p>
  
  <p>Try to javadoc all methods and variables, especially public, protected
  and default access methods and member variables. Also add code comments
  when you think it's necessary (like assumptions).</p>
  
  <p>Variables are declared in the inner scope.</p>
  
  <source>
  while( myListIterator.hasNext() )
  {
      final String myString = (String)myListIterator.next();
  }
  </source>
  
  <p>Variable should be descriptive and ideally English words. The exceptions
  being; loop counters (usually use i, j and k), exceptions (use concatenation
  of word separating characters - ie SocketException is abbreviated as se) and
  other commonly used abbreviations (ie sb for StringBuffer).</p>
  <source>
  try
  {
      for( int i = 0; i &lt; 10; i++ )
      {
          // some stuff
      }
  }
  catch( final FileNotFoundException fnfe )
  {
      // some stuff
  }
  catch( final IndexOutOfBoundsException ioobe )
  {
      // some stuff
  }
  </source>
  <p>
  Use String concatenation except in extremely performance sensitive
  sections. This leaves StringBuffer optimization to the compiler.
  So use:</p>
  <source>
  final String myString = "test " + "for " + "performances";
  </source>
  <p>Try not to declare a method as 'synchronized'.  If a method accesses
  a shared resource then surround accesses to that resource with
  a synchronized block. Ideally the synchronized block should surround
  the smallest possible area. For example:</p>
  <source>
  public void sharedMethod()
  {
      String display = null;
  
      synchronized( this )
      {
          display = mySharedObject.getHelloWorld();
      }
  
      System.out.println( display );
  }
  </source>
  <p>If you are within a static method, then you may have to create
  a static object whose sole purpose in life is to provide the
  lock you need. Alternatively you could use the Class object for
  the class you are in. That is, if you're in class MyClass, use
  "MyClass.class".</p>
  <p>Have the names of all member instance fields start with the prefix "m_".
  Example:</p>
  
  <source>
  class MyClass
  {
      Class m_class = MyClass.class;
      int m_users;
  }
  </source>
  
  <p>Don't chain method calls. The below:</p>
  <source>
  Thing thing = (MyThing)myObject.doSomething().doSomethingElse().getMyThing();
  </source>
  <p>is considered bad practice because it hides problems relating to
  synchronization, resource management, etc. The example above might
  become:</p>
  <source>
  final MySomething something = myObject.doSomething();
  final MyElse somethingElse = something.doSomethingElse();
  
  Thing thing = somethingElse.getMyThing();
  </source>
  <p>The extra typing will help keep the code bug-free.</p>
  
  <p>Thanks for your cooperation.</p>
  
  <p>-The Avalon Team</p>
  
  </section>
  
  </body>
  </document>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/cvs.xml
  
  Index: cvs.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
  
   <header>
    <title>Apache Avalon Project: CVS Repositories</title>
    <authors>
     <person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
    </authors>
   </header>
  
  <body>
  
  <section>
  	<title>Bleeding-edge only</title>
  	<p>If you are looking to download the source code for stable versions of the avalon
  	projects, you're in the wrong place. You should download a source release from
  	<link href="srcdownload.cgi">the source download page</link></p>
  </section>
  <section>
  	<title>About CVS</title>
  	<p>CVS, the Concurrent Versions System is a revision control system useful for
  	management of source code, and is the predominant version control system used at
  	apache. See <link href="http://www.cvshome.org/">The CVS Homepage</link> for
  	more about CVS.</p>
  </section>
  <section>
  	<title>CVS data</title>
  	<p>If you know what you're doing, all you need to know:</p>
  	<source>
  	anonymous CVSROOT: :pserver:anoncvs@cvs.apache.org:/home/cvspublic
  	viewcvs: http://cvs.apache.org/viewcvs.cgi/
  	modules:
  		avalon-sandbox			# alpha &amp; pre-alpha code
  		jakarta-avalon			# framework and documentation
  		jakarta-avalon-apps		# avalon applications
  		jakarta-avalon-excalibur	# component/utility/container repository
  		jakarta-avalon-cornerstone	# component repository
  		jakarta-avalon-logkit		# cool logging toolkit
  		jakarta-avalon-phoenix		# the phoenix container and related libraries
  		jakarta-avalon-site		# this website
  	</source>
  </section>
  <section>
  	<title>Getting the sources from CVS under windows</title>
  	<p>There's a few options for you:</p>
  	
  	<section>
  		<title>Use cygwin</title>
  		
  		<p><link href="http://www.cygwin.com/">Cygwin</link> is a free software suite
  		of ports of popular linux tools and utilities to run natively under windows.
  		Among it is a port of the cvs application. If you use cygwin, follow the linux
  		instructions.</p>
  	</section>
  	<section>
  		<title>Use the commandline tools</title>
  		
  		<p>The CVS utilities are available as native windows binaries. Get them from
  		<link href="http://www.cvshome.org/">The CVS Homepage</link>. To use these
  		tools, open a command window (click Start > Run..., then type 'cmd'), then
  		enter the following commands:</p>
  		
  		<source>
  		rem you can use any directory in place of C:\cvs
  		rem replace $CVSUTILS with where you installed the cvs binary, or with
  		rem nothing if you added the utility to your PATH
  		mkdir C:\cvs
  		cd C:\cvs
  		$CVSUTILS\cvs.exe -d :pserver:anoncvs@cvs.apache.org login
  		rem enter anoncvs when promted for a password, then hit enter
  		rem the below command should be on one line
  		$CVSUTILS\cvs.exe -z3 -d :pserver:anoncvs@cvs.apache.org checkout jakarta-avalon
  		      jakarta-avalon-excalibur jakarta-avalon-cornerstone
  		      jakarta-avalon-phoenix jakarta-avalon-logkit jakarta-avalon-site
  		      avalon-sandbox jakarta-site xml-forrest
  		</source>
  		
  		<p>This will take a while, depending on your connection. Go ahead and grab
  		yourself a coffee or ten. When done, you should have checked out all avalon
  		sources and the most important utility libraries you need to build it (save
  		for <link href="http://ant.apache.org/">Apache Ant</link>, which you should
  		go install right now if you haven't already).</p>
  	</section>
  	<section>
  		<title>Use TortoiseCVS</title>
  		
  		<p>Screenshots coming soon....</p>
  	</section>
  	<section>
  		<title>Use WinCVS</title>
  		
  		<p>Screenshots coming soon....</p>
  	</section>
  </section>
  <section>
  	<title>Getting the sources from CVS under linux</title>
  	
  	<p>Coming soon...</p>
  </section>
  
  </body>
  </document>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/features.xml
  
  Index: features.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
  
   <header>
    <title>Avalon Project - Features</title>
    <authors>
     <person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
    </authors>
   </header>
  
  <body>
  
  <section>
  <title>Introduction</title>
    <p>The Avalon project is so large and broad in scope that it is not easy
    to provide a simple list of features in the form of "Avalon provides
    Component X which will fulfill role Y in your project Z perfectly".</p>
  
    <p>Most of Avalon is oriented towards server development (though many parts
    can be, and are, used in other software domains). As such, it delivers all
    those features server applications require (stability, performance, etc),
    and does so very well.</p>
  
    <section>
  <title>Avalon Framework</title>
      <p>At the very core of our project is the Avalon Framework subproject.
      This framework is very stable and in daily use in many applications, from
      straightforward desktop products to large scale enterprise applications.<br/>
      After an initial learning curve, this framework will help you
      create a better software architecture. In this way, it's role is as
      fundamental as, say Object-Oriented Programming or Design Patterns.</p>
  
      <p>All other avalon subprojects make use of the framework. This has allowed
      us to provide truly pluggable components which can be used in any
      programming environment without requiring gargantuan supporting applications.</p>
    </section>
  
    <section>
  <title>Avalon Excalibur</title>
      <p>Avalon Excalibur provides you reusable components. Because our framework
      has been thought out so well, it becomes very easy to create quality
      components quickly. While many of the components in Excalibur are
      oriented towards server development (like a generic pooling implementation),
      others are very useful in other contexts as well (like utilities to help
      with internationalization).<br/>
      Instead of listing the features of every single package here, I suggest you
      look at the
      <link href="http://jakarta.apache.org/avalon/excalibur">
        Excalibur project page
      </link> for more information.</p> 
    </section>
  
    <section>
  <title>Avalon LogKit</title>
      <p>Avalon LogKit is a feature-rich logging package. It can be used as an
      Alternative to other logging packages like Jakarta's
      <link href="http://jakarta.apache.org/log4j">Log4J</link> or the (massively
      inferior)
      <link href="http://java.sun.com/j2se/1.4/docs/guide/util/logging/index.html">Logging API</link>
      included in JDK 1.4.<br/>
      Please see the 
      <link href="http://jakarta.apache.org/avalon/logkit/features.html">
        Logkit Features document
      </link> for more information.</p>
    </section>
  
    <section>
  <title>Avalon Phoenix</title>
      <p>Phoenix is a micro-kernel. It takes care of low level application details
      so you can focus on your unique requirments. While this may sound to you
      like a servlet or EJB container, phoenix has a very different scope. Where
      you can use EJBs to connect to a database, phoenix is the basis on which to
      run that database.<br/>
      With that said, you may now start to see the phoenix edge: it provides all
      of the features that make you love Servlet Engines so much (and several
      more), without restricting you to the specific servlet use case. You can
      use Avalon Phoenix to run your servlet engine, database, and other server
      components, as well as your java-enabled desktop.</p>
  
      <p>Take a look at the
      <link href="http://jakarta.apache.org/avalon/phoenix">
        Phoenix project page
      </link> to learn how it manages to do all of this.</p>
    </section>
  
    <section>
  <title>Avalon Applications</title>
      <p>Avalon Applications is a repository for Phoenix-enabled Applications.
      It contains a JDBC-compliant database, a Macromedia Flash-compatible XML socket
      server, and more. You'll also find a list of applications elsewhere on the
      web that run on phoenix. Go to the
      <link href="http://jakarta.apache.org/avalon/apps">
        Applications project page
      </link> to find out all about them.</p>
    </section>
  </section>
  
  </body>
  </document>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/getting-started.xml
  
  Index: getting-started.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
  	<header>
  		<title>Avalon - Getting Started</title>
  			<authors>
  				<person name="Robert McIntosh" email="rmcintosh@bull-enterprises.com"/>
  			</authors>
  	</header>
  	<body>
  		<section>
  <title>Introduction</title>
  			<p>We've worked hard to write complete documentation for all the
  			different parts of avalon. Unfortunately, this means there is quite
  			a bit of documentation to sort through =)</p>
  		</section>
  
  		<section>
  <title>Avalon for Beginners</title>
  			<p>An effort is underway to write a concise, example-oriented guide
  			to avalon that will get you up and running in about 2 minutes. You
  			can find the draft
  			<link href="excalibur/tweety/avalon-for-beginners.html">here</link>.</p>
  		</section>
  
  		<section>
  <title>Developing with Avalon</title>
  			<p>Another really neat document is our
  			<link href="developing/index.html">Developing with Avalon whitepaper</link>.
  			It's quite extensive, but very thorough and well-written. If you're an
  			experienced software engineer, you'll definately appreciate it.</p>
  		</section>
  
  		<section>
  <title>Other documentation</title>
  			<p>All the various subproject contain quite a bit of documentation
  			as well. I'll point you in the direction of the getting started
  			documentation for each of them.</p>
  
  			<section>
  <title>Avalon Framework</title>
  				<p>Both the Avalon for Beginners and the Developing with Avalon
  				paper introduce you to avalon framework. We suggest you start
  				with one of these.</p>
  			</section>
  
  			<section>
  <title>Avalon Excalibur</title>
  				<p>Unfortunately, the Excalibur documentation as a whole is in
  				bad shape, though some of the components it contains have really
  				complete documentation otherwise.</p>
  			</section>
  
  			<section>
  <title>Avalon Cornerstone</title>
  				<p>Much the same is true for the cornerstone documentation. We
  				suggest you read the
  				<link href="cornerstone/index.html">overview</link>, then
  				browse the
  				<link href="cornerstone/api/index.html">javadocs</link>
  				for more information.</p>
  			</section>
  
  			<section>
  <title>Avalon Phoenix</title>
  				<p>The
  				<link href="phoenix/getting-started.html">Avalon Phoenix getting started document</link>
  				desribes the HelloWorld demo Service demo. Tt will take you
  				through downloading, installing and then running the demo step
  				by step so it is an easy place tp start</p>
  			</section>
  
  			<section>
  <title>Avalon Logkit</title>
  				<p>You will most likely not use logkit by itself, but
  				rather with Phoenix or another container, so you don't normally
  				need to learn much about logkit. If you are interested in learning
  				more about it, there's a really good
  				<link href="logkit/whitepaper.html">whitepaper</link>
  				on it (it doesn't have a real 'getting started' document).</p>
  			</section>
  
  			<section>
  <title>Avalon Applications</title>
  				<p>The Phoenix documentation takes you through setting up the
  				Demo application; for the others there is no getting started
  				documentation.</p>
  			</section>
  		</section>
  
  		<section>
  <title>When you do get lost...</title>
  			<p>When you get stuck in sources, documentation, and the mailing list archive,
  			post your questions to the user mailing list (information on it is
  			<link href="http://jakarta.apache.org/site/mail.html">here</link>). For
  			many, Avalon poses a steep learning curve, and we'll try and help you
  			flatten it as much as we can.</p>
  		</section>
  	</body>
  </document>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/license.xml
  
  Index: license.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
  
   <header>
    <title>Avalon Project - Apache Public License</title>
    <authors>
      <person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
    </authors>
   </header>
  
  <body>
  <section>
  <title>Avalon Public License</title>
  
  <source>
   ============================================================================
                     The Apache Software License, Version 1.1
   ============================================================================
   
   Copyright (C) 1997-2001 The Apache Software Foundation. All rights reserved.
   
   Redistribution and use in source and binary forms, with or without modifica-
   tion, are permitted provided that the following conditions are met:
   
   1. Redistributions of  source code must  retain the above copyright  notice,
      this list of conditions and the following disclaimer.
   
   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
   
   3. The end-user documentation included with the redistribution, if any, must
      include  the following  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
   
   4. The names "Jakarta", "Avalon", "Excalibur", "Avalon Framework" and 
      "Apache Software Foundation"  must not be used to endorse or promote 
      products derived  from this  software without  prior written permission. 
      For written permission, please contact apache@apache.org.
   
   5. Products  derived from this software may not  be called "Apache", nor may
      "Apache" appear  in their name,  without prior written permission  of the
      Apache Software Foundation.
   
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
   APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
   INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
   DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
   OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
   ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
   (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
   This software  consists of voluntary contributions made  by many individuals
   on  behalf of the Apache Software  Foundation. For more  information on the 
   Apache Software Foundation, please see &lt;http://www.apache.org/&gt;.
  
  </source>
  </section>
  </body>
  </document>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/mailing-lists.xml
  
  Index: mailing-lists.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
  <document>
  
   <header>
    <title>Apache Avalon Project: Mailing Lists</title>
    <authors>
     <person name="Avalon Documentation Team" email="avalon-dev@jakarta.apache.org"/>
    </authors>
   </header>
  
  <body>
  
  <section>
  <title>Please follow netiquette!</title>
    <p>A mailing list is an electronic discussion forum that anyone can subscribe to.
    When someone sends an email message to the mailing list, a copy of that message is
    broadcast to everyone who is subscribed to that mailing list. Mailing lists provide
    a simple and effective communication mechanism. With potentially thousands of
    subscribers, there is a
    <link href="http://jakarta.apache.org/site/mail.html">common set of etiquette
    guidelines</link> that you should observe.</p>
  </section>
    <section>
      <title>The lists</title>
      <section>
        <title>The Avalon User List</title>
        <p>
  	<em>Light Traffic</em>
  	<link href="mailto:avalon-users-subscribe@jakarta.apache.org">Subscribe</link>
  	<link href="mailto:avalon-users-unsubscribe@jakarta.apache.org">Unsubscribe</link>
  	<link href="http://www.mail-archive.com/avalon-users@jakarta.apache.org/">Archive</link>
  	<link href="nntp://news.gmane.org/gmane.comp.jakarta.avalon.user">News gateway</link>
        </p>
        <p>
  	This list is for users that are using Avalon in their own projects to ask
  	questions, share knowledge, and discuss issues related to using the Avalon
  	suite of software.
        </p>
      </section>
      <section>
        <title>The Avalon Developer List</title>
        <p>
  	<em>Medium Traffic</em>
  	<link href="mailto:avalon-dev-subscribe@jakarta.apache.org">Subscribe</link>  
  	<link href="mailto:avalon-dev-unsubscribe@jakarta.apache.org">Unsubscribe</link> 
  	<link href="http://www.mail-archive.com/avalon-dev@jakarta.apache.org/">Archive</link> 
  	<link href="nntp://news.gmane.org/gmane.comp.jakarta.avalon.devel">News gateway</link>
        </p>
        <p>
  	This list is for developers that are maintaining Avalon or wanting to influence
  	its design to ask questions, share knowledge, and discuss issues related to developing 
  	and the Avalon framework.
        </p>
      </section>
      <section>
        <title>The Avalon CVS List</title>
        <p>
  	<em>Medium Traffic</em> 
  	<link href="mailto:avalon-cvs-subscribe@jakarta.apache.org">Subscribe</link>  
  	<link href="mailto:avalon-cvs-unsubscribe@jakarta.apache.org">Unsubscribe</link> 
  	<link href="http://www.mail-archive.com/avalon-cvs@jakarta.apache.org/">Archive</link> 
  	<link href="nntp://news.gmane.org/gmane.comp.jakarta.avalon.cvs">News gateway</link>
        </p>
        <p>
          Changes to the Avalon CVSes are echoed to this list.
        </p>
      </section>
  </section>
  
  </body>
  </document>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/mission.xml
  
  Index: mission.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
        <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
        <document> 
          <header> 
            <title>Apache Avalon project: Mission statement</title> 
          </header> 
          <body> 
            <section>
              <title>Shaping up....</title>
              <p>We're still working on setting up a charter 'n stuff. See
  	    <link href="http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-avalon/src/proposal/CHARTER.txt?rev=HEAD&amp;content-type=text/plain">the draft charter</link>
  	    for now, as well as the board resolution, in the
  	    <link href="http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-avalon/STATUS.txt?rev=HEAD&amp;content-type=text/plain">status file</link>.</p>
            </section>
          </body>
      </document>
  
  
  
  1.1                  jakarta-avalon-site/src/documentation/content/xdocs/news.xml
  
  Index: news.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
        <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
        <document> 
          <header> 
            <title>Apache Avalon project: News and Status</title> 
          </header> 
          <body> 
            <section>
              <title>Status</title>
              <p>See the
  	    <link href="http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-avalon/STATUS.txt?rev=HEAD&amp;content-type=text/plain">status file</link>
  	    for the current project status.
  	    .</p>
            </section>
  	  <section>
  	    <title>Avalon is now a top-level project!</title>
  	    
  	    <p>The Apache board has passed a resolution to set up a "top-level" project
  	    for Avalon. This basically means avalon gets its own PMC made up of the avalon
  	    committers, reporting directly to the board. The complete text of the resolution
  	    that passed on Monday 18 November 2002, which created this project is:</p>
  <source>
    WHEREAS, the Board of Directors deems it to be in
    the best interests of the Foundation and consistent with
    the Foundation's purpose to establish a Project Management
    Committee charged with the creation and maintenance of
    open-source software related to component and service
    management, for distribution at no charge to the public.
  
    NOW, THEREFORE, BE IT RESOLVED, that a Project Management
    Committee (PMC), to be known as the "Avalon PMC", be and
    hereby is established pursuant to Bylaws of the Foundation;
    and be it further
  
    RESOLVED, that the Avalon PMC be and hereby is responsible
    for the creation and maintenance of software related to
    component and service management, based on software licensed
    to the Foundation; and be it further
  
    RESOLVED, that the office of "Vice President, Avalon" be and
    hereby is created, the person holding such office to serve
    at the direction of the Board of Directors as the chair of the
    Avalon PMC, and to have primary responsibility for management
    of the projects within the scope of responsibility of the
    Avalon PMC; and be it further
  
    RESOLVED, that the persons listed immediately below be and hereby
    are appointed to serve as the initial members of the Avalon PMC:
  
    * Nicola Ken Barozzi
    * Stephen McConnell
    * Leo Sutic
    * Leo Simons
    * Paul Hammant
    * Marcus Crafter
    * Carsten Ziegeler
    * Pete Royal
    * Berin Loritsch
    * Jeff Turner
  
    NOW, THEREFORE, BE IT FURTHER RESOLVED, that Nicola Ken Barozzi
    be and hereby is appointed to the office of Vice President, Avalon,
    to serve in accordance with and subject to the direction of the
    Board of Directors and the Bylaws of the Foundation until death,
    resignation, retirement, removal or disqualification, or until a
    successor is appointed; and be it further
  
    RESOLVED, that the initial Avalon PMC be and hereby is tasked
    with the creation of a set of bylaws intended to encourage open
    development and increased participation in the Avalon Project;
    and be it further
  
    RESOLVED, that the initial Avalon PMC be and hereby is tasked
    with the migration and rationalization of the Jakarta PMC
    Avalon subproject; and be it further
  
    RESOLVED, that all responsibility pertaining to the Jakarta
    Avalon sub-project and encumbered upon the Jakarta PMC are
    hereafter discharged.
  </source>	    
  	  </section>
            <section>
              <title>Older News</title>
              <p>See the
  	    <link href="http://jakarta.apache.org/site/news/index.html">Jakarta News Page</link>
  	    for older news.
  	    .</p>
            </section>
          </body>
      </document>
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>