Skip to content

Commit c342367

Browse files
committed
docs: trying to cleanup/categorize features better.
The features lists are long and rambling and some features don't really match their headers. Not sure this is better but... Also added private and self-hosted as a feature category.
1 parent ba50fdb commit c342367

File tree

1 file changed

+54
-42
lines changed

1 file changed

+54
-42
lines changed

doc/features.txt

Lines changed: 54 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -12,58 +12,76 @@ Roundup is an easy-to-use and -install issue-tracking system with
1212
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

15-
*simple to install*
16-
- instant-gratification ``python demo.py`` takes less than 5 minutes :)
17-
- installation (including web interface) takes about 30 minutes
18-
- five templates included in the distribution for you to base your tracker on
15+
*simple to try*
16+
- instant-gratification ``python demo.py`` or spin up a Docker
17+
container in less than 5 minutes :)
18+
- base your tracker on one of five templates included in the distribution
1919
- play with the demo, customise it and then use *it* as the template for
2020
your production tracker
2121
- requires *no* additional support software - python (3.6+ or 2.7) is
2222
enough to get you going
23+
24+
*simple to install*
25+
- basic installation (including web interface) takes about 30 minutes
2326
- supports embedded databases like sqlite_ and dbm so you don't
2427
need a separate database like mysql_ or postgresql_
28+
- can be run in a container (Docker)
29+
30+
*flexible*
31+
- manage your issues your way
32+
- use it to track bugs, features, user feedback, sales opportunities,
33+
fleet maintenance requests, office issues, milestones, ...
34+
- can be deployed in your network running as a stand alone
35+
web server (with optional reverse proxy), WSGI (with
36+
mod_wsi under Apache, Nginx w/ gunicorn), FastCGI, as a
37+
plain cgi script, or through Zope
2538

2639
*simple to use*
40+
- default trackers have a basic web interface usable on any device
41+
- users may sign themselves up, there may be automatic signup for
42+
incoming email and users may handle their own password reset requests
2743
- accessible through the web (html, REST or XMLRPC), email,
2844
command-line or Python programs
29-
- use it to track bugs, features, user feedback, sales opportunities,
30-
fleet maintenance requests, office issues, milestones, ...
31-
- issues have their own mini mailing list (nosy list)
3245
- indexed Full Text Search (FTS) gives fast responses to searches across all
3346
messages and indexed string properties
34-
- users may sign themselves up, there may be automatic signup for
35-
incoming email and users may handle their own password reset requests
3647
- automatically keeps a full history of changes to issues with
3748
configurable verbosity and easy access to information about who created
3849
or last modified *any* item in the database
50+
- issues have their own mini mailing list (nosy list) to keep
51+
everybody informed
52+
53+
*fast, scalable*
54+
- with the sqlite, mysql and postgresql backends, Roundup is
55+
also fast and scalable, easily handling thousands of issues and users
56+
with decent response times
57+
- database indexes are automatically added for those backends that
58+
support them (sqlite, mysql and postgresql)
59+
- support for the Xapian, Whoosh, sqlite or Postgres full-text
60+
indexing engines for large trackers
3961

4062
*highly configurable*
41-
- web interface HTML is fully editable
42-
- database schema is also fully editable (only the "user" class is required)
63+
- web interface HTML is fully editable using TAL or jinja2
64+
templating languages
65+
- database schema is fully editable (only the "user" class is required)
4366
with a full set of data types (including dates and many-to-many relations)
44-
across all storages available
67+
across all available databases
4568
- fine grained authorization can be based on the properties of
4669
a user and resource (`Attribute or Policy/Purpose Based Access
4770
Control (ABAC or PBAC)
4871
<https://en.wikipedia.org/wiki/Attribute-based_access_control>`_))
4972
- customised automatic auditors and reactors to perform
5073
actions before and after changes are made to entries in the database,
5174
or may veto the creation or modification of items in the database
52-
- samples are provided for all manner of configuration changes and
53-
customisations
5475

55-
*fast, scalable*
56-
- with the sqlite, mysql and postgresql backends, roundup is
57-
also fast and scalable, easily handling thousands of issues and users
58-
with decent response times
59-
- database indexes are automatically added for those backends that
60-
support them (sqlite, mysql and postgresql)
61-
- support for the Xapian, Whoosh, sqlite or postgres full-text
62-
indexing engines for large trackers
76+
*private and self-hosted*
77+
- your data on your servers
78+
- used for AI training only if you want
79+
- can be containerized or not
6380

6481
*documented*
65-
- documentation exists for installation, upgrading, maintenance, users and
66-
customisation
82+
- documentation exists for installation, upgrading, maintenance, users
83+
- samples are provided for all manner of configuration changes and
84+
customisations
6785

6886
*web interface*
6987
- fully editable interfaces for listing and display of items
@@ -73,47 +91,41 @@ from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition.
7391
to register new users
7492
- authentication of user registration and user-driven password resetting
7593
using email and one time keys
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
7994
- searching may be performed using many constraints, including a full-text
8095
search of messages attached to issues
8196
- file attachments (added through the web or email) are served up with the
8297
correct content-type and filename
83-
- email change messages generated by roundup appear to be sent by the
98+
- email change messages generated by Roundup appear to be sent by the
8499
person who made the change, but responses will go back through the nosy
85100
list by default
86-
- flexible access control built around Permissions and Roles with assigned
87-
Permissions
88101
- detects concurrent user changes
89102
- saving and editing of user-defined queries which may optionally be
90103
shared with other users
91104

92105
*e-mail interface*
93106
- may be set up using sendmail-like delivery alias, POP polling or mailbox
94107
polling
95-
- may auto-register users who send in mail and aren't known to roundup
108+
- may auto-register users who send in mail and aren't known to Roundup
96109
- nosy list configuration controls how people are added and when messages
97110
are sent to the list
98111
- auto-filing of "unformatted" messages into a particular class
99-
- e-mail attachments are handled sanely, being attached to the issue they're
112+
- e-mail attachments are handled sanely: attached to the issue they're
100113
intended for, and forwarded on to the nosy list
101114
- sane handling of content-type and content-encoding of messages (text/plain
102115
preferred in all situations)
103116
- email packages that display threading will show issue messages correctly
104117
threaded
105-
- users may send in messages from multiple addresses and be associated
106-
with the same roundup username
107-
- built-in security features like TLS and APOP
118+
- users can have multiple email addresses may associated
119+
with the same Roundup username/account
120+
- built-in security features like TLS, APOP, IMAPS w/ OAUTH
108121

109122
*command-line*
110-
- may be used to interactively manage roundup databases
123+
- may be used to interactively manage Roundup databases
111124
- may be scripted using standard shell scripting
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
115-
- a variety of sample shell scripts are provided (weekly reports, issue
116-
generation, ...)
125+
- Roundup's API may also be used by other Python programs
126+
- a variety of sample shell and Python scripts are provided (weekly
127+
reports, new issue from command line, daily open ticket summary
128+
email sent to the person assigned to the tickets, ...)
117129

118130
*xmlrpc interface*
119131
- simple remote tracker interface with basic HTTP authentication
@@ -125,8 +137,8 @@ from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition.
125137
*RESTful interface*
126138
- accessible using basic HTTP authentication at /rest starting point
127139
- able to be extended with new endpoints
128-
- authentication can be done using JSON Web Tokens (JWT)
129140
- CORS support for use by third party web pages.
141+
- authentication can be done using JSON Web Tokens (JWT)
130142
- see the `rest guide`_ for details.
131143

132144
.. _sqlite: https://www.sqlite.org/index.html

0 commit comments

Comments
 (0)