more doc work - new improved overview doc

Author: Richard Jones

doc/Makefile

@@ -3,7 +3,8 @@ STXTOHTML = rst2html
 
 SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
     glossary.txt implementation.txt index.txt design.txt \
-    installation.txt upgrading.txt user_guide.txt maintenance.txt
+    installation.txt upgrading.txt user_guide.txt maintenance.txt \
+	overview.txt
 
 COMPILED := $(SOURCE:.txt=.html)
 

doc/index.txt

@@ -5,13 +5,14 @@ Roundup: an Issue-Tracking System for Knowledge Workers
 Contents
 ========
 
-- Overview_ and Features_ (pdf__)
-- Installation_ (pdf__) and Upgrading_ existing installs (pdf__)
-- `User Guide`_ (pdf__)
-- Configuring and `Customising Roundup`_ (pdf__)
-- `Maintaining Roundup Trackers`_ (pdf__)
-- `Roundup's Design`_ (pdf__) (original_)
-- `Developing Roundup`_ (pdf__)
+- Overview_ and Features_
+- Installation_ and Upgrading_ existing installs
+- `Frequently Asked Questions`_
+- `User Guide`_
+- Configuring and `Customising Roundup`_
+- `Maintaining Roundup Trackers`_
+- `Roundup's Design`_ (original_)
+- `Developing Roundup`_ 
 - Contact_
 - Acknowledgements_
 - License_
@@ -24,8 +25,7 @@ For general support enquiries about usage, a mailing list is available:
     [email protected]
 
 If you've got a great idea for roundup, or have found a bug, please
-submit
-an issue to the tracker at: 
+submit an issue to the tracker at: 
 
     http://sourceforge.net/tracker/?group_id=31577
 
@@ -95,6 +95,7 @@ See COPYING.txt in the software distribution for the licensing terms.
 .. _Features: features.html
 .. _Installation: installation.html
 .. _Upgrading: upgrading.html
+.. _`Frequently Asked Questions`: FAQ.html
 .. _`User Guide`: user_guide.html
 .. _`Customising Roundup`: customizing.html
 .. _`Maintaining Roundup Trackers`: maintenance.html
@@ -103,13 +104,3 @@ See COPYING.txt in the software distribution for the licensing terms.
 .. _original: spec.html
 .. _Upgrading: upgrading.html
 
-.. __: overview.pdf
-.. __: features.pdf
-.. __: installation.pdf
-.. __: upgrading.pdf
-.. __: user_guide.pdf
-.. __: customizing.pdf
-.. __: maintenance.pdf
-.. __: design.pdf
-.. __: developers.pdf
-

doc/installation.txt

@@ -2,7 +2,7 @@
 Installing Roundup
 ==================
 
-:Version: $Revision: 1.45 $
+:Version: $Revision: 1.46 $
 
 .. contents::
 
@@ -470,6 +470,7 @@ Schedule
 
 To have the Roundup mail gateway run periodically to poll a POP email address,
 set the following up in Scheduled Tasks:
+
 Run
  ``c:\cygwin\bin\bash.exe -c "roundup-mailgw /opt/roundup/trackers/support pop roundup:roundup@mail-server"``
 Start In
@@ -498,7 +499,7 @@ This is usually done via the following 2 steps:
 Linux
 -----
 
-Make sure you read the instructions under `shared environment setup`_.
+Make sure you read the instructions under `shared environment steps`_.
 
 Python 2.1.1 as shipped with SuSE7.3 might be missing module
 ``_weakref``.
@@ -509,7 +510,7 @@ Solaris
 
 You'll need to build Python.
 
-Make sure you read the instructions under `shared environment setup`_.
+Make sure you read the instructions under `shared environment steps`_.
 
 -------------------------------------------------------------------------------