Skip to content

Commit 4197677

Browse files
committed
docs: fixups to features lists.
Rearrange features under different/better headings. Try to use parallel phrasing for items in list. Still a lot to do here to better market Roundup and increase users/contributors.
1 parent 715e76e commit 4197677

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

doc/features.txt

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,42 +8,45 @@
88
Roundup Features
99
================
1010

11-
Roundup is a simple-to-use and -install issue-tracking system with
12-
web, e-mail and command-line interfaces. It is based on the winning design
11+
Roundup is an easy-to-use and -install issue-tracking system with
12+
web, e-mail and command-line interfaces. Based on the winning design
1313
from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition.
1414

1515
*simple to install*
16-
- installation (including web interface) takes about 30 minutes
1716
- instant-gratification ``python demo.py`` takes less than 5 minutes :)
17+
- installation (including web interface) takes about 30 minutes
1818
- five templates included in the distribution for you to base your tracker on
1919
- play with the demo, customise it and then use *it* as the template for
2020
your production tracker
21-
- requires *no* additional support software - python (2.7 or 3.6+) is
21+
- requires *no* additional support software - python (3.6+ or 2.7) is
2222
enough to get you going
23-
- supports higher-performance storage backends like sqlite_,
24-
mysql_ and postgresql_
23+
- supports embedded databases like sqlite_ and dbm so you don't
24+
need a separate database like mysql_ or postgresql_
2525

2626
*simple to use*
2727
- accessible through the web (html, REST or XMLRPC), email,
2828
command-line or Python programs
29-
- may be used to track bugs, features, user feedback, sales opportunities,
30-
milestones, ...
31-
- automatically keeps a full history of changes to issues with
32-
configurable verbosity and easy access to information about who created
33-
or last modified *any* item in the database
29+
- use it to track bugs, features, user feedback, sales opportunities,
30+
fleet maintenance requests, office issues, milestones, ...
3431
- issues have their own mini mailing list (nosy list)
32+
- indexed Full Text Search (FTS) gives fast responses to searches across all
33+
messages and indexed string properties
3534
- users may sign themselves up, there may be automatic signup for
3635
incoming email and users may handle their own password reset requests
36+
- automatically keeps a full history of changes to issues with
37+
configurable verbosity and easy access to information about who created
38+
or last modified *any* item in the database
3739

3840
*highly configurable*
3941
- web interface HTML is fully editable
4042
- database schema is also fully editable (only the "user" class is required)
4143
with a full set of data types (including dates and many-to-many relations)
4244
across all storages available
43-
- authorization is fine grained and can be based on the properties of
44-
a user and resource (`ABAC, PBAC (Attribute or Policy/Purpose Based Access
45-
Control <https://en.wikipedia.org/wiki/Attribute-based_access_control>`_))
46-
- customised automatic auditors and reactors may be written that perform
45+
- fine grained authorization can be based on the properties of
46+
a user and resource (`Attribute or Policy/Purpose Based Access
47+
Control (ABAC or PBAC)
48+
<https://en.wikipedia.org/wiki/Attribute-based_access_control>`_))
49+
- customised automatic auditors and reactors to perform
4750
actions before and after changes are made to entries in the database,
4851
or may veto the creation or modification of items in the database
4952
- samples are provided for all manner of configuration changes and
@@ -55,8 +58,6 @@ from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition.
5558
with decent response times
5659
- database indexes are automatically added for those backends that
5760
support them (sqlite, mysql and postgresql)
58-
- indexed full text search (FTS) gives fast responses to searches across all
59-
messages and indexed string properties
6061
- support for the Xapian, Whoosh, sqlite or postgres full-text
6162
indexing engines for large trackers
6263

@@ -72,9 +73,9 @@ from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition.
7273
to register new users
7374
- authentication of user registration and user-driven password resetting
7475
using email and one time keys
75-
- may be run using WSGI or through CGI as a normal cgi script, as a
76-
stand-alone web server, under mod_wsgi (mod_python is deprecated)
77-
or through Zope
76+
- may be run using a stand alone web server, WSGI (with mod_wsi or
77+
the depricated mod_python under Apache), as a plain cgi script, or
78+
through Zope
7879
- searching may be performed using many constraints, including a full-text
7980
search of messages attached to issues
8081
- file attachments (added through the web or email) are served up with the
@@ -108,8 +109,9 @@ from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition.
108109
*command-line*
109110
- may be used to interactively manage roundup databases
110111
- may be scripted using standard shell scripting
111-
- roundup's API may also be used by other Python programs - a sample is
112-
provided that runs once a day and emails people their assigned issues
112+
- roundup's API may also be used by other Python programs - for
113+
example a Python script torun daily email people their assigned
114+
issues is provided
113115
- a variety of sample shell scripts are provided (weekly reports, issue
114116
generation, ...)
115117

0 commit comments

Comments
 (0)