You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by he...@apache.org on 2003/06/24 10:16:59 UTC

cvs commit: jakarta-turbine-2/xdocs/services navigation.xml

henning     2003/06/24 01:16:59

  Modified:    xdocs    index.xml navigation.xml todo.xml
               xdocs/howto navigation.xml
               xdocs/services navigation.xml
  Added:       xdocs    how-to-help.xml
  Log:
  As our "todo" document was more of a "how to help" document, I renamed it
  and added a real "todo" list to the docs where we can collect ideas and
  stuff to be worked on. This is basically a copy of a list that I had lying
  around here.
  
  Revision  Changes    Path
  1.6       +7 -4      jakarta-turbine-2/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-2/xdocs/index.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- index.xml	13 Dec 2002 07:40:54 -0000	1.5
  +++ index.xml	24 Jun 2003 08:16:58 -0000	1.6
  @@ -142,10 +142,13 @@
   
   <p>
   We really need and appreciate any contributions you can give. This
  -includes documentation help, source code and feedback. Discussion about
  -changes should come in the form of source code and/or very detailed and
  -well thought out constructive feedback. The <a href="todo.html">TODO</a>
  -document has details and hints as to areas that still need work.
  +includes documentation help, source code and feedback. Discussion
  +about changes should come in the form of source code and/or very
  +detailed and well thought out constructive feedback. The <a
  +href="how-to-help.html">How To Help</a> document has details and hints
  +how to get engaged with Turbine Development. We also have a <a
  +href="todo.html">To Do</a> document that describes work to do with
  +the current Turbine code.
   </p>
   
   <ul>
  
  
  
  1.10      +1 -0      jakarta-turbine-2/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-2/xdocs/navigation.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- navigation.xml	2 May 2003 15:09:27 -0000	1.9
  +++ navigation.xml	24 Jun 2003 08:16:58 -0000	1.10
  @@ -29,6 +29,7 @@
   
       <menu name="Development">
         <item name="Proposals"             href="/proposals.html"/>
  +      <item name="How To Help"           href="/how-to-help.html"/>
         <item name="Todo"                  href="/todo.html"/>
       </menu>
   
  
  
  
  1.6       +23 -73    jakarta-turbine-2/xdocs/todo.xml
  
  Index: todo.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-2/xdocs/todo.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- todo.xml	21 Jan 2003 05:21:18 -0000	1.5
  +++ todo.xml	24 Jun 2003 08:16:58 -0000	1.6
  @@ -2,93 +2,43 @@
   
   <document>
    <properties>
  -  <title>Turbine Todo</title>
  -     <author email="celkins@scardini.com">Christopher Elkins</author>
  -     <author email="quintonm@bellsouth.net">Quinton McCombs</author>
  +  <title>Turbine To Do</title>
  +  <author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
    </properties>
   
   <body>
   
  -<section name="How to help">
  -
   <p>
  -  If you are a new developer to Turbine or even an existing developer, these are
  -  areas where you can take ownership and help complete. Please do not ask us how
  -  you can help, but rather specific questions about how you think that these items
  -  should be implemented. It is up to you to take initiative and provide solutions
  -  to the missing functionality described below. ;-)
  -</p>
  -
  -<p>
  -  It is always possible to take ownership of any portion of the project. The way
  -  to do this is to post a message to the turbine-dev mailing list.  Just explain
  -  what you are wanting to work on or any ideas that you might have on the subject.
  -</p>
  +This file is intended to collect ideas, problems and work
  +to do with the current Turbine code. 
   
  +<section name="Work to do for the current release">
   <p>
  -    Documentation is <b>*always*</b> appreciated in any form.  The documentation for
  -    Turbine exists in basically four forms.
  -    <ul>
  -        <li>
  -            XML formatted docs (xdoc) - This is used to generate the documentation
  -            on the jakarta site.  The source for this documentation can be found
  -            in the xdocs directory in the source distribution.  To submit additional
  -            documentation in this form or patches to existing documentation, please
  -            create an issue is the
  -            <a href="http://scarab.werken.com/scarab/issues">issue tracking system</a>
  -            and attach the patch files (or new files).
  -        </li>
  -        <li>
  -            Mailing list - The archives of turbine-user@jakarta.apache.org and
  -            turbine-dev@jakarta-apache.org are an excellent source of information
  -            for the project.  Answering questions that are asked on the mailing list
  -            or simply posting information that might be of use to other Turbine users
  -            would be very welcome contribution to the project.
  -        </li>
  -        <li>
  -            The <a href="http://nagoya.apache.org/wiki/apachewiki.cgi?TurbineProjectPages">
  -            Apache Wiki</a> another repository of documentation for the project.  It
  -            contains development information, user documentation, how-to documents,
  -            discussion of new features, etc.  Anyone can add new pages and edit existing
  -            pages very easily!  This is perhaps the easiest way to contribute documentation
  -            (well, second only to the mailing lists).
  -        </li>
  -        <li>
  -            The javadocs are another very important form of documentation for the project.
  -            Changes to this form of documentation should be in the form of patches.  To submit
  -            them, create a new issue in the
  -            <a href="http://scarab.werken.com/scarab/issues">issue tracking system</a>
  -            and attach your patch(s).
  -        </li>
  -    </ul>
  -    The documentation is probabley the easiest area for anyone to contribute in.  If you are
  -    new to Turbine and learning your way around, documenting what you learn and submitting
  -    it in any other the various forms would be appreciated.
  +  <ul>
  +    <li>Bring all the jars up to date, get all needed jars on ibiblio</li>
  +  </ul>
   </p>
  +</section>
   
  +<section name="Stuff that needs to be looked into (current release or next release)">
   <p>
  -    Testing is another area in which help is always needed.  This could consist of simply
  -    reporting problems that you run into using Turbine.  It could also consist of submitting
  -    code to perform unit tests.  Turbine uses JUnit and Cactus for testing.  You can find
  -    examples in the src/test directory of the source distribution.
  +  <ul>
  +    <li>Googlezation of URLs (<a href="http://marc.theaimsgroup.com/?l=turbine-user&m=103008672127247&w=2">See here</a>)</li>
  +    <li>Make sure that pull tools get refreshed correctly under all circumstances</li>
  +    <li>Check lifetimes of authorized and session tools if the application is not the standard login-logout application</li>
  +    <li>Move AvalonComponentService to the Fortress container (suggested by the avalon-dev list)</li>
  +  </ul>
   </p>
  +</section>
   
  +<section name="Blue Skying for future Turbine releases">
   <p>
  -    If you do discover a defect in the Turbine product, please create a defect issue in
  -    the <a href="http://scarab.werken.com/scarab/issues">issue tracking system</a> clearly
  -    discribing the problem.  If you can take the time to track down the source of the problem,
  -    it would certainly help speed the process of getting it corrected.  Of course, actually
  -    fixing the problem and attaching a patch to the issue would be greatly appreciated.
  +  <ul>
  +    <li>Move forward to a component based architecture (avalonization)</li>
  +    <li>"Steal" the pipeline from the Turbine 3 code base</li>
  +    <li>Decouple the code base into core, components and toolbox</li>
  +  </il>
   </p>
  -
  -<p>
  -    You can also contribute to the project by enhancing existing functionality and/or
  -    adding new functionality.  There is a current list of requested features on the
  -    <a href="http://nagoya.apache.org/wiki/apachewiki.cgi?JakartaTurbine2/WishList">
  -    Apache Wiki</a>.  Everyone is encouraged to take part in the discussion, design, and
  -    implementation.
  -</p>
  -
   </section>
   
   </body>
  
  
  
  1.1                  jakarta-turbine-2/xdocs/how-to-help.xml
  
  Index: how-to-help.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
   <properties>
    <title>How To Help with Turbine Development</title>
       <author email="celkins@scardini.com">Christopher Elkins</author>
       <author email="quintonm@bellsouth.net">Quinton McCombs</author>
   </properties>
  
  <body>
  
  <section name="How to help">
  
  <p>
    If you are a new developer to Turbine or even an existing developer, these are
    areas where you can take ownership and help complete. Please do not ask us how
    you can help, but rather specific questions about how you think that these items
    should be implemented. It is up to you to take initiative and provide solutions
    to the missing functionality described below. ;-)
  </p>
  
  <p>
    It is always possible to take ownership of any portion of the project. The way
    to do this is to post a message to the turbine-dev mailing list.  Just explain
    what you are wanting to work on or any ideas that you might have on the subject.
  </p>
  
  <p>
      Documentation is <b>*always*</b> appreciated in any form.  The documentation for
      Turbine exists in basically four forms.
      <ul>
          <li>
              XML formatted docs (xdoc) - This is used to generate the documentation
              on the jakarta site.  The source for this documentation can be found
              in the xdocs directory in the source distribution.  To submit additional
              documentation in this form or patches to existing documentation, please
              create an issue is the
              <a href="http://scarab.werken.com/scarab/issues">issue tracking system</a>
              and attach the patch files (or new files).
          </li>
          <li>
              Mailing list - The archives of turbine-user@jakarta.apache.org and
              turbine-dev@jakarta-apache.org are an excellent source of information
              for the project.  Answering questions that are asked on the mailing list
              or simply posting information that might be of use to other Turbine users
              would be very welcome contribution to the project.
          </li>
          <li>
              The <a href="http://nagoya.apache.org/wiki/apachewiki.cgi?TurbineProjectPages">
              Apache Wiki</a> another repository of documentation for the project.  It
              contains development information, user documentation, how-to documents,
              discussion of new features, etc.  Anyone can add new pages and edit existing
              pages very easily!  This is perhaps the easiest way to contribute documentation
              (well, second only to the mailing lists).
          </li>
          <li>
              The javadocs are another very important form of documentation for the project.
              Changes to this form of documentation should be in the form of patches.  To submit
              them, create a new issue in the
              <a href="http://scarab.werken.com/scarab/issues">issue tracking system</a>
              and attach your patch(s).
          </li>
      </ul>
      The documentation is probabley the easiest area for anyone to contribute in.  If you are
      new to Turbine and learning your way around, documenting what you learn and submitting
      it in any other the various forms would be appreciated.
  </p>
  
  <p>
      Testing is another area in which help is always needed.  This could consist of simply
      reporting problems that you run into using Turbine.  It could also consist of submitting
      code to perform unit tests.  Turbine uses JUnit and Cactus for testing.  You can find
      examples in the src/test directory of the source distribution.
  </p>
  
  <p>
      If you do discover a defect in the Turbine product, please create a defect issue in
      the <a href="http://scarab.werken.com/scarab/issues">issue tracking system</a> clearly
      discribing the problem.  If you can take the time to track down the source of the problem,
      it would certainly help speed the process of getting it corrected.  Of course, actually
      fixing the problem and attaching a patch to the issue would be greatly appreciated.
  </p>
  
  <p>
      You can also contribute to the project by enhancing existing functionality and/or
      adding new functionality.  There is a current list of requested features on the
      <a href="http://nagoya.apache.org/wiki/apachewiki.cgi?JakartaTurbine2/WishList">
      Apache Wiki</a>.  Everyone is encouraged to take part in the discussion, design, and
      implementation.
  </p>
  
  </section>
  
  </body>
  </document>
  
  
  
  1.5       +1 -0      jakarta-turbine-2/xdocs/howto/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-2/xdocs/howto/navigation.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- navigation.xml	30 Jan 2003 00:32:12 -0000	1.4
  +++ navigation.xml	24 Jun 2003 08:16:59 -0000	1.5
  @@ -50,6 +50,7 @@
       <menu name="Development">
         <item name="Project Map"           href="/project-map.html"/>
         <item name="Proposals"             href="/proposals.html"/>
  +      <item name="How To Help"           href="/how-to-help.html"/>
         <item name="Todo"                  href="/todo.html"/>
       </menu>
   
  
  
  
  1.6       +1 -0      jakarta-turbine-2/xdocs/services/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-2/xdocs/services/navigation.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- navigation.xml	18 Feb 2003 16:14:31 -0000	1.5
  +++ navigation.xml	24 Jun 2003 08:16:59 -0000	1.6
  @@ -63,6 +63,7 @@
       <menu name="Development">
         <item name="Project Map"           href="/project-map.html"/>
         <item name="Proposals"             href="/proposals.html"/>
  +      <item name="How To Help"           href="/how-to-help.html"/>
         <item name="Todo"                  href="/todo.html"/>
       </menu>
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org