diff doc/admin_guide.txt @ 3250:8634ea9b2d1c

doc updates
author Richard Jones <richard@users.sourceforge.net>
date Thu, 31 Mar 2005 00:45:25 +0000
parents 33e3ba342e93
children 74db49467de8
line wrap: on
line diff
--- a/doc/admin_guide.txt	Tue Mar 29 16:37:53 2005 +0000
+++ b/doc/admin_guide.txt	Thu Mar 31 00:45:25 2005 +0000
@@ -2,7 +2,7 @@
 Administration Guide
 ====================
 
-:Version: $Revision: 1.16 $
+:Version: $Revision: 1.17 $
 
 .. contents::
 
@@ -67,6 +67,7 @@
 In both cases, if no logfile is specified then logging will simply be sent
 to sys.stderr with only logging of ERROR messages.
 
+
 Configuring roundup-server
 ==========================
 
@@ -163,6 +164,7 @@
 2. `software upgrade`_
 3. `migrating backends`_
 4. `moving a tracker`_
+5. `migrating from other software`_
 
 
 Tracker Backup
@@ -255,6 +257,31 @@
 6. start the tracker web and email frontends on the new machine.
 
 
+Migrating From Other Software
+-----------------------------
+
+You have a couple of choices. You can either use a CSV import into Roundup,
+or you can write a simple Python script which uses the Roundup API
+directly. The latter is almost always simpler -- see the "scripts"
+directory in the Roundup source for some example uses of the API.
+
+"roundup-admin import" will import data into your tracker from a 
+directory containing files with the following format:
+
+- one colon-separated-values file per Class with columns for each property,
+  named <classname>.csv
+- one colon-separated-values file per Class with journal information,
+  named <classname>-journals.csv (this is required, even if it's empty)
+- if the Class is a FileClass, you may have the "content" property 
+  stored in separate files from the csv files. This goes in a directory
+  structure::
+
+      <classname>-files/<N>/<designator>
+
+  where ``<designator>`` is the item's ``<classname><id>`` combination.
+  The ``<N>`` value is ``int(<id> / 1000)``.
+
+
 Running the Servers
 ===================
 

Roundup Issue Tracker: http://roundup-tracker.org/