Code

pre-beta2 stuff
[roundup.git] / doc / announcement.txt
1 =====================================================
2 SC-Track Roundup 0.5 beta2 - an issue tracking system
3 =====================================================
5 Note: This is the first of two beta releases of the newest version of Roundup.
6 It is 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 upgrading from
8 0.4, you must read doc/upgrading.txt!
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.
13 This beta release fixes the following specific problems:
14  . all backends now have a .close() method, and it's used everywhere
15  . fixed bug in detectors __init__
16  . switched the default issue item display to only show issue summary
17    (added instructions to doc to make it display entire content)
18  . MANIFEST.in was missing a lot of template files
19  . added generic item editing
20  . much nicer layout of template rendering errors
21  . added context/is_edit_ok and context/is_view_ok convenience methods and
22    implemented use of them in the classic template
24 A lot has been done since 0.4:
26 - new backend for metakit (thanks Gordon McMillan)
27 - new backend for gadfly (it's as done as it's going to get)
28 - further split the dbm backends from the core code, allowing easier
29   non-dict-like backends (eg metakit, RDB)
30 - implemented and used the new access control mechanisms (Permissions, Roles)
31 - switched templating to use Zope's PageTemplates (yay!)
32 - switched to sessions for web authentication
33 - added Boolean and Number types
34 - full-text search may also search certain String properties
35 - fixed the journal bloat
36 - updated design document for new access controls
37 - updated customisation document, including more examples
38 - entire database export and import (incl files)
39 - better mailgw help message (feature request #558562)
40 - re-enabled link backrefs from messages (feature request #568714)
41 - the page layout is now templatable
42 - re-worked cgi interface to abstract out the explicit "issue" interface
43 - have index page handle mid-page errors better so header and footer are
44   still visible
45 - saving of named search queries
46 - we handle "not found", access and item page render errors better
47 - fixed double-submit by having new-item-submit redirect at end
48 - daemonify roundup-server (fork, logfile, pidfile)
49 - modify cgitb to display PageTemplate errors better
50 - rename to "instance" to "tracker"
51 - have roundup.cgi pick up tracker config from the environment 
52 - revamped look and feel in web interface
53 - cleaned up stylesheet usage
54 - several bug fixes and documentation fixes
56 Source and documentation is available at the website:
57      http://roundup.sourceforge.net/
58 Release Info (via download page):
59      http://sourceforge.net/projects/roundup
60 Mailing lists - the place to ask questions:
61      http://sourceforge.net/mail/?group_id=31577
64 About Roundup
65 =============
67 Roundup is a simple-to-use and -install issue-tracking system with 
68 command-line, web and e-mail interfaces. It is based on the winning design 
69 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
71 Note: Ping is not responsible for this project. The contact for this project 
72 is richard@users.sourceforge.net.
74 Roundup manages a number of issues (with flexible properties such as 
75 "description", "priority", and so on) and provides the ability to:
77 (a) submit new issues,
78 (b) find and edit existing issues, and
79 (c) discuss issues with other participants.
81 The system will facilitate communication among the participants by managing
82 discussions and notifying interested parties when issues are edited. One of
83 the major design goals for Roundup that it be simple to get going. Roundup
84 is therefore usable "out of the box" with any python 2.1+ installation. It
85 doesn't even need to be "installed" to be operational, though a
86 disutils-based install script is provided.
88 It comes with two issue tracker templates (a classic bug/feature tracker and
89 a help desk) and five database back-ends (anydbm, bsddb, bsddb3, metakit and
90 gadfly).