Code

pre-release stuff
[roundup.git] / doc / announcement.txt
1 It is with a huge sigh of relief that I announce this first beta of
2 Roundup version 0.7.
4 If you're upgrading from an older version of Roundup you *must* follow
5 the "Software Upgrade" guidelines given in the maintenance documentation.
7 No, really, this is a BETA and if you don't follow the upgrading steps,
8 particularly the bit about BACKING UP YOUR DATA, I'm NOT GOING TO BE HELD
9 RESPONSIBLE. This release is NOT FOR GENERAL USE.
11 I would *greatly* appreciate people giving this release a whirl with a
12 copy of their existing setup. It's only through real-world testing of
13 beta releases that we can ensure that older trackers will be OK.
15 This release introduces far too many features to list here. Some
16 highlights:
18 - added postgresql backend (originally from sf patch 761740, many changes
19   since)
20 - RDBMS backends implement their session and one-time-key stores and
21   full-text indexers; thus they are now performing their own locking
22   internally
23 - added new "actor" automatic property (indicates user who cause the last
24   "activity")
25 - all RDBMS backends have sensible data typed columns and indexes on
26   several columns
27 - we support confirming registration by replying to the email (sf bug
28   763668)
29 - all HTML templating methods now automatically check for permissions
30   (either view or edit as appropriate), greatly simplifying templates
32 Roundup requires python 2.1.3 or later for correct operation.
34 To give Roundup a try, just download (see below), unpack and run::
36     python demo.py
38 Source and documentation is available at the website:
39      http://roundup.sourceforge.net/
40 Release Info (via download page):
41      http://sourceforge.net/projects/roundup
42 Mailing lists - the place to ask questions:
43      http://sourceforge.net/mail/?group_id=31577
46 About Roundup
47 =============
49 Roundup is a simple-to-use and -install issue-tracking system with
50 command-line, web and e-mail interfaces. It is based on the winning design
51 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
53 Note: Ping is not responsible for this project. The contact for this
54 project is richard@users.sourceforge.net.
56 Roundup manages a number of issues (with flexible properties such as
57 "description", "priority", and so on) and provides the ability to:
59 (a) submit new issues,
60 (b) find and edit existing issues, and
61 (c) discuss issues with other participants.
63 The system will facilitate communication among the participants by managing
64 discussions and notifying interested parties when issues are edited. One of
65 the major design goals for Roundup that it be simple to get going. Roundup
66 is therefore usable "out of the box" with any python 2.1+ installation. It
67 doesn't even need to be "installed" to be operational, though a
68 disutils-based install script is provided.
70 It comes with two issue tracker templates (a classic bug/feature tracker and
71 a minimal skeleton) and seven database back-ends (anydbm, bsddb, bsddb3,
72 sqlite, metakit, mysql and postgresql).