Documentation cleanup, added info for potential (and current) developers

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@699 57a73879-2fb5-44c3-a270-3262357dd7e2

diff --git a/doc/.cvsignore b/doc/.cvsignore
new file mode 100644 (file)
index 0000000..5f80470
--- /dev/null
+++ b/doc/.cvsignore
@@ -0,0 +1,8 @@
+announcement.html
+customizing.html
+developers.html
+getting_started.html
+implementation.html
+index.html
+installation.html
+user_guide.html

diff --git a/doc/FAQ.txt b/doc/FAQ.txt
index d78da85fc508123806d8cfd23854b7fb54d2954a..459966bab60696b1579ebfbdbaa0177c95aeddba 100644 (file)
--- a/doc/FAQ.txt
+++ b/doc/FAQ.txt
@@ -1,10 +1,13 @@
 Roundup FAQ
 ===========
 
-:Date: $Date: 2002-03-13 23:00:48 $
+:Version: $Revision: 1.8 $
 
 NOTE: This is just a grabbag, most of this should go into documentation.
 
+.. contents::
+
+
 Changing HTML layout
 --------------------
 
@@ -123,3 +126,9 @@ directly to the roundup-mailgw script as the roundup user.::
 If that doesn't raise any errors, the problem is the permissions of the
 MTA. 
 
+-----------------
+
+Back to `Table of Contents`_
+
+.. _`Table of Contents`: index.html
+

diff --git a/doc/acknowledgements.txt b/doc/acknowledgements.txt
deleted file mode 100644 (file)
index 7cf087d..0000000
--- a/doc/acknowledgements.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-Acknowledgements
-================
-
-Go Ping, you rock! Also, go Bizar Software for letting me implement this system on their time.
- 
- 

diff --git a/doc/customizing.txt b/doc/customizing.txt
index b2c97297d1fc2db9bb3cca50c8c10c1f42114485..270f5f711f009cbbcbd40253b74ce137b74c3520 100644 (file)
--- a/doc/customizing.txt
+++ b/doc/customizing.txt
@@ -1,6 +1,11 @@
 Customising Roundup
 ===================
 
+:Version: $Revision: 1.4 $
+
+.. contents::
+
+
 Instances have the following structure:
 
 +-------------------+--------------------------------------------------------+
@@ -585,4 +590,9 @@ eliminate sections of the spool section if the property has no entries::
       </tr>
      </property>
 
+-----------------
+
+Back to `Table of Contents`_
+
+.. _`Table of Contents`: index.html
 

diff --git a/doc/developers.txt b/doc/developers.txt
new file mode 100644 (file)
index 0000000..b633bf8
--- /dev/null
+++ b/doc/developers.txt
@@ -0,0 +1,58 @@
+Developing Roundup
+==================
+
+:Version: $Revision: 1.1 $
+
+Note: the intended audience of this document is the developers of the core
+Roundup code. If you just wish to alter some behaviour of your Roundup
+installation, see `customising roundup`_.
+
+.. contents::
+
+Getting Started
+---------------
+
+Anyone wishing to help in the development of Roundup must read `Roundup's
+Design Document`_.
+
+All development is coordinated through two resources:
+
+- roundup-dev mailing list at
+  http://lists.sourceforge.net/mailman/listinfo/roundup-devel
+- Sourceforge's issue trackers at
+  https://sourceforge.net/tracker/?group_id=31577
+
+Small Changes
+-------------
+
+Most small changes can be submitted through the Feature tracker, with patches
+attached that give context diffs of the affected source.
+
+
+CVS Access
+----------
+
+To get CVS access, contact richard@users.sourceforge.net.
+
+Developers with CVS access should follow these simple guidelines:
+
+- subscribe to roundup-checkins to receive checkin notifications from the
+  other developers with CVS access
+- discuss any changes with the other developers on roundup-dev. If nothing
+  else, this makes sure there's no rude shocks
+- run pychecker over changed code
+- write unit tests for changes you make (where possible), and ensure that
+  all unit tests run before committing changes
+
+The administrators of the project reserve the right to boot developers who
+consistently check in code which is either broken or takes the codebase in
+directions that have not been agreed to.
+
+
+-----------------
+
+Back to `Table of Contents`_
+
+.. _`Table of Contents`: index.html
+.. _`Customising Roundup`: customizing.html
+.. _`Roundup's Design Document`: spec.html

diff --git a/doc/getting_started.txt b/doc/getting_started.txt
index 860e57dce0bf2ad4aa149e1b7e42f2e86e30a2dc..e23997c46696691cb522b7bbb43f62532cf69852 100644 (file)
--- a/doc/getting_started.txt
+++ b/doc/getting_started.txt
@@ -1,6 +1,11 @@
 Getting Started
 ===============
 
+:Version: $Revision: 1.2 $
+
+.. contents::
+
+
 The following instructions assume that you have installed roundup. If you
 haven't, you may still proceed - just run the commands as
 "``PYTHONPATH=. python roundup/scripts/roundup_admin.py``" for
@@ -255,4 +260,12 @@ To add issues, use one of the following interfaces:
    automatically created a new issue in the database using the contents of
    the e-mail.
 
+-----------------
+
+Back to `Table of Contents`_
+
+Next: `User Guide`_
+
+.. _`table of contents`: index.html
+.. _`user guide`: user_guide.html
 

diff --git a/doc/implementation.txt b/doc/implementation.txt
index 7f3fa69ad20d2e41a76b7471a54d8539b99bce7a..e2eca31c84913eb3f0fdf16a7e27b4194ef565b4 100644 (file)
--- a/doc/implementation.txt
+++ b/doc/implementation.txt
@@ -1,6 +1,8 @@
 Implementation notes
 ====================
 
+:Version: $Revision: 1.2 $
+
 [see also the roundup package docstring]
 
 There have been some modifications to the spec. I've marked these in the
@@ -43,3 +45,9 @@ In short:
 
  roundup.py - the command-line tool has a lot more commands at its disposal
 
+-----------------
+
+Back to `Table of Contents`_
+
+.. _`Table of Contents`: index.html
+

diff --git a/doc/index.txt b/doc/index.txt
index e940eae09e44c8c1f4f591a1ff21edb8351cff9d..d2f18fdfa945532fe3906b0b8141e37df0ca61f4 100644 (file)
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -1,4 +1,6 @@
-*Roundup: an Issue-Tracking System for Knowledge Workers*
+=======================================================
+Roundup: an Issue-Tracking System for Knowledge Workers
+=======================================================
 
 Contents
 ========
@@ -9,6 +11,7 @@ Contents
 - `User Guide`_
 - `Customising Roundup`_
 - `Roundup's Design Document`_
+- `Developing Roundup`_
 - Contact_
 - Acknowledgements_
 - License_
@@ -18,6 +21,7 @@ Contents
 .. _`Getting Started`: getting_started.html
 .. _`User Guide`: user_guide.html
 .. _`Customising Roundup`: customizing.html
+.. _`Developing Roundup`: developers.html
 .. _`Roundup's Design Document`: spec.html
 
 

diff --git a/doc/installation.txt b/doc/installation.txt
index 46b4cdb2073271514a5d5326a35b6844245be276..446ff6a5c5d57005c0effd2c3d783fbc24c118fe 100644 (file)
--- a/doc/installation.txt
+++ b/doc/installation.txt
@@ -1,21 +1,10 @@
 Installing Roundup
 ==================
 
-`Table of contents`_
+:Version: $Revision: 1.2 $
 
-- Overview_
+.. contents::
 
-  - `Classic Template`_
-  - `Extended Template`_
-
-- Prerequisites_
-
-  - `Testing your Python`_
-
-- `Getting Roundup`_
-- `Installation`_
-- `Further Reading`_
-- `Platform-Specific Notes`_
 
 Overview
 ========
@@ -213,6 +202,8 @@ Python 2.1.1 as shipped with SuSE7.3 might be missing module
 
 -------------------------------------------------------------------------------
 
+Back to `Table of Contents`_
+
 Next: `Getting Started`_
 
 .. _`table of contents`: index.html
@@ -220,4 +211,3 @@ Next: `Getting Started`_
 .. _`roundup specification`: spec.html
 .. _`customising roundup`: customizing.html
 
-$Id: installation.txt,v 1.1 2002-03-13 23:00:48 richard Exp $

diff --git a/doc/user_guide.txt b/doc/user_guide.txt
index db83f9276bc4f386f1d1752eea3e5d1b7f8c9be1..2743efaa97ab5e49e86c216aea77b01341a7e208 100644 (file)
--- a/doc/user_guide.txt
+++ b/doc/user_guide.txt
@@ -1,6 +1,10 @@
 User Guide
 ==========
 
+:Version: $Revision: 1.2 $
+
+.. contents::
+
 Command Line Tool
 -----------------
 
@@ -274,3 +278,9 @@ The journal recorded by the hyperdatabase on the "recipients" property then
 provides a log of when the message was sent to whom.
 
 
+-----------------
+
+Back to `Table of Contents`_
+
+.. _`Table of Contents`: index.html
+