Code

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