quintonm 2003/03/11 10:46:27
Modified: xdocs/common documentation.xml
Log:
Minor updates from a patch supplied by Jeff Linwood
Revision Changes Path
1.5 +12 -13 jakarta-turbine-site/xdocs/common/documentation.xml
Index: documentation.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-site/xdocs/common/documentation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- documentation.xml 26 Jan 2002 07:33:40 -0000 1.4
+++ documentation.xml 11 Mar 2003 18:46:27 -0000 1.5
@@ -8,6 +8,7 @@
<author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
<author email="[EMAIL PROTECTED]">Martin Poeschl</author>
<author email="[EMAIL PROTECTED]">Daniel Rall</author>
+ <author email="[EMAIL PROTECTED]">Jeff Linwood</author>
</properties>
<body>
@@ -16,9 +17,9 @@
<p>
The Turbine Documentation Project is the process of documenting Turbine, inside
-and out, for the user community. Opensource projects live and die by their
-community participation, as a software project is more than just source code,
-other components such as documentation have an important role in the process.
+and out, for the user community. Open source projects live and die by their
+community participation, as a software project is more than just source code.
+Other components such as documentation have an important role in the process.
As Software Engineers tend towards the habit of communicating in code,
documentation is often skimped on, which can alienate the new or less
experienced user. This component of the Turbine project will formalise the
@@ -32,7 +33,7 @@
<section name="What Can I do to Contribute?">
<p>
-Turbine can always improve it's documentation, there are many area's that always
+Turbine can always improve its documentation, there are many areas that always
need attention;
</p>
@@ -72,12 +73,10 @@
<ul>
<li>Screens and Actions - How the Default Screen and Action work.</li>
-<li>Pull Howto</li>
<li>Torque Howto - including OM description</li>
-<li>Intake Howto</li>
<li>Advanced Criteria - needs more description of comparitors and Criterion.
</li>
-<li>Services - All the services need documentation.</li>
+<li>Services - Many of the services need documentation.</li>
</ul>
<p>
@@ -95,7 +94,7 @@
<p>
The website documentation is the main component outside of the source code and
-javadocs. If there are ommisions on the website that you think need to be
+javadocs. If there are omissions on the website that you think need to be
documented or written in, please go ahead and do it.
</p>
@@ -122,9 +121,9 @@
<section name="Turbine and TDK Tutorials">
<p>
-How to use Turbine with other technologies such as JSP, JBoss etc etc How to use
+How to use Turbine with other technologies such as JSP, JBoss etc etc. How to use
Torque, how to get a tdk project up and running. How to use the objects in
-Turbine for your projects such As Peers and Criteria.
+Torque for your projects such as Peers and Criteria.
</p>
</section>
@@ -133,7 +132,7 @@
<p>
Monitor mailing lists for common discussions and modify into a format that is
-sutiable for the Turbine Website and xdocs directory, plus adding a few choice
+suitable for the Turbine Website and xdocs directory, plus adding a few choice
comments. From there it can be improved.
</p>
@@ -153,9 +152,9 @@
<p>
To get started, read all the current documentation and find an area that you
-know a bit about. If that area isnt covered, you can improve Turbine by
+know a bit about. If that area isn't covered, you can improve Turbine by
documenting it. Write up the document, no matter how skeletal and email it to
-the Turbine-Users-List, making sure your are subscribed first. All documentation
+the Turbine-Users-List, making sure you are subscribed first. All documentation
of any kind is greatly appreciated.
</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
