info about how roundup is installed

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

diff --git a/doc/installation.txt b/doc/installation.txt
index dd8a602e4b6e2bd47b0704153c412e5fab5b31e7..7c0741c060b920d608386e5d5da6cf74283f1f53 100644 (file)
--- a/doc/installation.txt
+++ b/doc/installation.txt
@@ -2,7 +2,7 @@
 Installing Roundup
 ==================
 
-:Version: $Revision: 1.66 $
+:Version: $Revision: 1.67 $
 
 .. contents::
 
@@ -31,10 +31,10 @@ Roundup scripts
 Prerequisites
 =============
 
-Python 2.1.3 or newer with a functioning anydbm or bsddb module. Download the
-latest version from http://www.python.org/. It is highly recommended that
-users install the latest patch version of python - 2.1.3, 2.2.3 or 2.3.2 -
-as these contain many fixes to serious bugs.
+Roundup requires Python 2.1.3 or newer with a functioning anydbm or
+bsddb module. Download the latest version from http://www.python.org/.
+It is highly recommended that users install the latest patch version
+of python as these contain many fixes to serious bugs.
 
 If you want to use Berkeley DB bsddb3 with Roundup, use version 3.3.0 or
 later. Download the latest version from http://pybsddb.sourceforge.net/.
@@ -97,6 +97,9 @@ installation:
    UNIX machine and want to restrict local access to roundup
 6. `additional language codecs`_
 
+For information about how Roundup installs, see the `maintenance
+documentation`_.
+
 
 Basic Installation Steps
 ------------------------

diff --git a/doc/maintenance.txt b/doc/maintenance.txt
index 98bed63022d0bb5c86e8ba58ecaafd251ac93d06..e7611908218f0861512ec7060fc69bd69e7053d5 100644 (file)
--- a/doc/maintenance.txt
+++ b/doc/maintenance.txt
@@ -2,10 +2,43 @@
 Maintaining Roundup Trackers
 ============================
 
-:Version: $Revision: 1.2 $
+:Version: $Revision: 1.3 $
 
 .. contents::
-   :depth: 1
+
+What does Roundup install?
+==========================
+
+There's two "installations" that we talk about when using Roundup:
+
+1. The installation of the software and its support files. This uses the
+   standard Python mechanism called "distutils" and thus Roundup's core code,
+   executable scripts and support data files are installed in Python's
+   directories. On Windows, this is typically:
+
+   Scripts
+     <python dir>\scripts\...
+   Core code
+     <python dir>\lib\site-packages\roundup\...
+   Support files
+     <python dir>\share\roundup\...
+
+   and on *nix (eg. Linux):
+
+   Scripts
+     <python root>/bin/...
+   Core code
+     <python root>/lib-<python version>/site-packages/roundup/...
+   Support files
+     <python root>/share/roundup/...
+
+2. The installation of a specific tracker. When invoking the roundup-admin
+   "inst" (and "init") commands, you're creating a new Roundup tracker. This
+   installs configuration files, HTML templates, detector code and a new
+   database. You have complete control over where this stuff goes through
+   both choosing your "tracker home" and the DATABASE variable in
+   config.py.
+
 
 Tasks
 =====
@@ -15,16 +48,18 @@ Maintenance of Roundup can involve one of the following:
 1. `tracker backup`_ 
 2. `software upgrade`_
 3. `migrating backends`_
+3. `moving a tracker`_
 
 
 Tracker Backup
-==============
+--------------
 
 Stop the web and email frontends and to copy the contents of the tracker home
 directory to some other place using standard backup tools.
 
+
 Software Upgrade
-================
+----------------
 
 Always make a backup of your tracker before upgrading software. Steps you may
 take:
@@ -40,9 +75,9 @@ take:
 7. upgrade the software
 8. restart your tracker
 
-Migrating Backends
-==================
 
+Migrating Backends
+------------------
 
 1. stop the existing tracker web and email frontends (preventing changes)
 2. use the roundup-admin tool "export" command to export the contents of
@@ -60,7 +95,7 @@ Migrating Backends
 
 
 Moving a Tracker
-================
+----------------
 
 If you're moving the tracker to a similar machine, you should: