doc/announcement.txt

   1 ===========================================================
   2 SC-Track Roundup 0.5 pre-release - an issue tracking system
   3 ===========================================================
   4
   5 Note: This is the final pre-release of the newest version of Roundup. It is
   6       strongly recommended that you maintain your existing 0.4 installation if
   7       you have one, and run 0.5 on a copy of the database. If you are
   8       upgrading from 0.4, you must read doc/upgrading.txt!
   9
  10 Roundup requires python 2.1.1 for correct operation. Support for dumbdbm
  11 requires python 2.1.2 or 2.2. 2.1.3 and 2.2.1 are recommended.
  12
  13 This release fixes the following specific problems:
  14
  15 - fixes to import/export
  16 - password edit now has a confirmation field
  17 - cleanups and fixes to the shipped classic template
  18 - new backend for sqlite (and it rocks :)
  19 - many performance improvements in dbm and sql backends
  20 - cgi.client base URL is now obtained from the config TRACKER_WEB (as a result
  21   request.url has gone away - there's too much magic in trying to figure
  22   what it should be)
  23 - cgi-bin script redirects to https now if the request was https
  24 - FileClass "content" property wasn't being returned by getprops() in most
  25   backends
  26 - we now verify instance attributes on instance open and throw a useful error
  27   if they're not all there
  28 - sf bug 611217 ] menu() has problems when labelprop==None
  29 - verify contents of tracker module when the tracker is opened
  30 - fixes to value parsing from edit forms
  31 - mailgw was missing an "import sys" (!)
  32 - setup now installs scripts with python -O flag, doubling performance in some
  33   cases (there's a lot of __debug__ use)
  34 - added getItem to HTMLClass so you can access arbitrary items in templates
  35 - replaced the content() callback ickiness with Page Template macro usage
  36 - changed the default CSS style to be less offensive to some ;)
  37 - better handling of Page Template compilation errors
  38 - sf bug 614188 ] Exception in mailgw.py
  39 - sf bug 613310 ] traceback on onexistant items
  40 - sf bug 613291 ] typos in nosy list
  41 - handle stupid mailers that QUOTE their Re; 'Re: "[issue1] bla blah"'
  42 - giving a user a Role that doesn't exist doesn't break stuff any more
  43 - revamped user guide, customisation guide, added basic maintenance guide
  44 - merged some bugfixes from the Zope Page Templates trunk
  45 - added the "minimal" template
  46
  47 A lot has been done since 0.4:
  48
  49 - new backend for metakit (thanks Gordon McMillan)
  50 - new backend for sqlite
  51 - new backend for gadfly (it's as done as it's going to get)
  52 - further split the dbm backends from the core code, allowing easier
  53   non-dict-like backends (eg metakit, RDB)
  54 - added Boolean and Number types
  55 - fixed the journal bloat
  56 - full-text search may also search certain String properties
  57 - entire database export and import (incl files)
  58 - implemented and used the new access control mechanisms (Permissions, Roles)
  59 - switched templating to use Zope's PageTemplates giving much more flexibility
  60 - revamped look and feel in web interface including cleaned up CSS usage
  61 - re-worked cgi interface to abstract out the explicit "issue" interface
  62 - switched to sessions for web authentication
  63 - saving of named search queries
  64 - updated design document for new access controls
  65 - updated customisation document, including more examples
  66 - added maintenance guide
  67 - better mailgw help message (feature request #558562)
  68 - we handle "not found", access and item page render errors better
  69 - fixed double-submit by having new-item-submit redirect at end
  70 - roundup-server may be a daemon now (fork, logfile, pidfile)
  71 - renamed "instance" to "tracker" everywhere, and "node" to "item" in most
  72   places
  73 - many more bug fixes, cleanups and minor improvements
  74
  75 Source and documentation is available at the website:
  76      http://roundup.sourceforge.net/
  77 Release Info (via download page):
  78      http://sourceforge.net/projects/roundup
  79 Mailing lists - the place to ask questions:
  80      http://sourceforge.net/mail/?group_id=31577
  81
  82
  83 About Roundup
  84 =============
  85
  86 Roundup is a simple-to-use and -install issue-tracking system with
  87 command-line, web and e-mail interfaces. It is based on the winning design
  88 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
  89
  90 Note: Ping is not responsible for this project. The contact for this project
  91 is richard@users.sourceforge.net.
  92
  93 Roundup manages a number of issues (with flexible properties such as
  94 "description", "priority", and so on) and provides the ability to:
  95
  96 (a) submit new issues,
  97 (b) find and edit existing issues, and
  98 (c) discuss issues with other participants.
  99
 100 The system will facilitate communication among the participants by managing
 101 discussions and notifying interested parties when issues are edited. One of
 102 the major design goals for Roundup that it be simple to get going. Roundup
 103 is therefore usable "out of the box" with any python 2.1+ installation. It
 104 doesn't even need to be "installed" to be operational, though a
 105 disutils-based install script is provided.
 106
 107 It comes with two issue tracker templates (a classic bug/feature tracker and
 108 a minimal skeleton) and six database back-ends (anydbm, bsddb, bsddb3, sqlite,
 109 metakit and gadfly).
 110