Mercurial > p > roundup > code
annotate doc/features.txt @ 8010:c10df5dfed95 2.4.0b1
Removed tag 2.4.1b1
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 27 May 2024 17:01:45 -0400 |
| parents | 788afca5aa15 |
| children | 4ed91247e8dc |
| rev | line source |
|---|---|
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6262
diff
changeset
|
1 .. meta:: |
|
6774
e7b4ad2c57ac
landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents:
6762
diff
changeset
|
2 :description: |
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6262
diff
changeset
|
3 Features of using the Roundup Issue Tracker. Describes |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6262
diff
changeset
|
4 all access methods, configuration and workflow capabilities. |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6262
diff
changeset
|
5 Links to detailed documentation. |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6262
diff
changeset
|
6 |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
7 ================ |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 Roundup Features |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 ================ |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
10 |
|
7990
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
11 Roundup is an easy-to-use and -install issue-tracking system with |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
12 web, e-mail and command-line interfaces. Based on the winning design |
| 6163 | 13 from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition. |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
14 |
| 1228 | 15 *simple to install* |
|
7990
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
16 - instant-gratification ``python demo.py`` takes less than 5 minutes :) |
| 1228 | 17 - installation (including web interface) takes about 30 minutes |
|
7351
1f8e41b0e97f
updates: template #, min version, timing on demo mode
John Rouillard <rouilj@ieee.org>
parents:
7259
diff
changeset
|
18 - five templates included in the distribution for you to base your tracker on |
|
2660
2ebeb53eb336
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2259
diff
changeset
|
19 - play with the demo, customise it and then use *it* as the template for |
|
2ebeb53eb336
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2259
diff
changeset
|
20 your production tracker |
|
7990
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
21 - requires *no* additional support software - python (3.6+ or 2.7) is |
|
2223
9b447ac40be3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2138
diff
changeset
|
22 enough to get you going |
|
7990
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
23 - supports embedded databases like sqlite_ and dbm so you don't |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
24 need a separate database like mysql_ or postgresql_ |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
25 |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 *simple to use* |
|
6762
f8ee14436371
Add fts search engines, add more rest doc.
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
27 - accessible through the web (html, REST or XMLRPC), email, |
|
f8ee14436371
Add fts search engines, add more rest doc.
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
28 command-line or Python programs |
|
7990
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
29 - use it to track bugs, features, user feedback, sales opportunities, |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
30 fleet maintenance requests, office issues, milestones, ... |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
31 - issues have their own mini mailing list (nosy list) |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
32 - indexed Full Text Search (FTS) gives fast responses to searches across all |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
33 messages and indexed string properties |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
34 - users may sign themselves up, there may be automatic signup for |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
35 incoming email and users may handle their own password reset requests |
|
2259
f47ab53269cd
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2258
diff
changeset
|
36 - automatically keeps a full history of changes to issues with |
|
f47ab53269cd
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2258
diff
changeset
|
37 configurable verbosity and easy access to information about who created |
|
f47ab53269cd
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2258
diff
changeset
|
38 or last modified *any* item in the database |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 |
| 1228 | 40 *highly configurable* |
| 41 - web interface HTML is fully editable | |
| 42 - database schema is also fully editable (only the "user" class is required) | |
| 43 with a full set of data types (including dates and many-to-many relations) | |
| 44 across all storages available | |
|
7990
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
45 - fine grained authorization can be based on the properties of |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
46 a user and resource (`Attribute or Policy/Purpose Based Access |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
47 Control (ABAC or PBAC) |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
48 <https://en.wikipedia.org/wiki/Attribute-based_access_control>`_)) |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
49 - customised automatic auditors and reactors to perform |
|
2138
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
1649
diff
changeset
|
50 actions before and after changes are made to entries in the database, |
|
3754
9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
Richard Jones <richard@users.sourceforge.net>
parents:
3748
diff
changeset
|
51 or may veto the creation or modification of items in the database |
| 2258 | 52 - samples are provided for all manner of configuration changes and |
| 53 customisations | |
| 1228 | 54 |
| 55 *fast, scalable* | |
|
3935
1dab48842cbd
Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents:
3839
diff
changeset
|
56 - with the sqlite, mysql and postgresql backends, roundup is |
|
2138
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
1649
diff
changeset
|
57 also fast and scalable, easily handling thousands of issues and users |
|
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
1649
diff
changeset
|
58 with decent response times |
|
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
1649
diff
changeset
|
59 - database indexes are automatically added for those backends that |
|
3935
1dab48842cbd
Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents:
3839
diff
changeset
|
60 support them (sqlite, mysql and postgresql) |
|
7351
1f8e41b0e97f
updates: template #, min version, timing on demo mode
John Rouillard <rouilj@ieee.org>
parents:
7259
diff
changeset
|
61 - support for the Xapian, Whoosh, sqlite or postgres full-text |
|
6762
f8ee14436371
Add fts search engines, add more rest doc.
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
62 indexing engines for large trackers |
| 1228 | 63 |
| 64 *documented* | |
| 65 - documentation exists for installation, upgrading, maintenance, users and | |
| 66 customisation | |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
67 |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
68 *web interface* |
| 1228 | 69 - fully editable interfaces for listing and display of items |
| 70 - extendable to include wizards, parent/meta bug displays, ... | |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
71 - differentiates between anonymous, known and admin users |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
72 - may be set up to require login, and may also only allow admin users |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
73 to register new users |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
74 - authentication of user registration and user-driven password resetting |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
75 using email and one time keys |
|
7990
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
76 - may be run using a stand alone web server, WSGI (with mod_wsi or |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
77 the depricated mod_python under Apache), as a plain cgi script, or |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
78 through Zope |
|
740
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
79 - searching may be performed using many constraints, including a full-text |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
80 search of messages attached to issues |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
81 - file attachments (added through the web or email) are served up with the |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
82 correct content-type and filename |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
83 - email change messages generated by roundup appear to be sent by the |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
84 person who made the change, but responses will go back through the nosy |
| 741 | 85 list by default |
| 2258 | 86 - flexible access control built around Permissions and Roles with assigned |
| 87 Permissions | |
| 88 - detects concurrent user changes | |
| 89 - saving and editing of user-defined queries which may optionally be | |
| 90 shared with other users | |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
91 |
| 741 | 92 *e-mail interface* |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
93 - may be set up using sendmail-like delivery alias, POP polling or mailbox |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
94 polling |
|
740
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
95 - may auto-register users who send in mail and aren't known to roundup |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
96 - nosy list configuration controls how people are added and when messages |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
97 are sent to the list |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
98 - auto-filing of "unformatted" messages into a particular class |
|
740
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
99 - e-mail attachments are handled sanely, being attached to the issue they're |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
100 intended for, and forwarded on to the nosy list |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
101 - sane handling of content-type and content-encoding of messages (text/plain |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
102 preferred in all situations) |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
103 - email packages that display threading will show issue messages correctly |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
104 threaded |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
105 - users may send in messages from multiple addresses and be associated |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
106 with the same roundup username |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
107 - built-in security features like TLS and APOP |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
108 |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
109 *command-line* |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
110 - may be used to interactively manage roundup databases |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
111 - may be scripted using standard shell scripting |
|
7990
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
112 - roundup's API may also be used by other Python programs - for |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
113 example a Python script torun daily email people their assigned |
|
788afca5aa15
docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents:
7794
diff
changeset
|
114 issues is provided |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
115 - a variety of sample shell scripts are provided (weekly reports, issue |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
116 generation, ...) |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
117 |
| 3839 | 118 *xmlrpc interface* |
| 119 - simple remote tracker interface with basic HTTP authentication | |
|
5695
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
120 available at the /xmlrpc endpoint. |
| 3839 | 121 - provides same access to tracker as roundup-admin, but based on |
| 122 XMLRPC calls | |
|
7470
c22b4f0364eb
Remove some easy/simple language.
John Rouillard <rouilj@ieee.org>
parents:
7351
diff
changeset
|
123 - see the `xmlrpc guide`_ for more details basic and advanced clients etc. |
|
5695
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
124 |
|
6762
f8ee14436371
Add fts search engines, add more rest doc.
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
125 *RESTful interface* |
|
5695
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
126 - accessible using basic HTTP authentication at /rest starting point |
|
6762
f8ee14436371
Add fts search engines, add more rest doc.
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
127 - able to be extended with new endpoints |
|
f8ee14436371
Add fts search engines, add more rest doc.
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
128 - authentication can be done using JSON Web Tokens (JWT) |
|
f8ee14436371
Add fts search engines, add more rest doc.
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
129 - CORS support for use by third party web pages. |
|
5695
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
130 - see the `rest guide`_ for details. |
| 3839 | 131 |
| 7259 | 132 .. _sqlite: https://www.sqlite.org/index.html |
|
5511
bfe8e52af1e7
more mentions of updated MySQL client module
Christof Meerwald <cmeerw@cmeerw.org>
parents:
5096
diff
changeset
|
133 .. _mysql: https://pypi.org/project/MySQL-python/ |
|
6262
ba82fb74f806
Update psycopg link to: https://www.psycopg.org/
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
134 .. _postgresql: https://www.psycopg.org/ |
|
5695
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
135 .. _`xmlrpc guide`: xmlrpc.html |
|
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
136 .. _`rest guide`: rest.html |