Mercurial > p > roundup > code
annotate doc/features.txt @ 6613:2eec7a500333
Doc updates for indexers.
change word size max from 25 to 50
phrase search syntax updated
clear up wording for automatic selection of xapian/whoosh
link user_guide to admin_guide for finding syntax for native_fts
searches.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 07 Feb 2022 22:52:03 -0500 |
| parents | 24e2eeb2ed9a |
| children | f8ee14436371 |
| rev | line source |
|---|---|
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6262
diff
changeset
|
1 .. meta:: |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6262
diff
changeset
|
2 :description language=en: |
|
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 |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 Roundup is a simple-to-use and -install issue-tracking system with |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 web, e-mail and command-line interfaces. It is 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* |
| 16 - installation (including web interface) takes about 30 minutes | |
|
2660
2ebeb53eb336
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2259
diff
changeset
|
17 - instant-gratification ``python demo.py`` :) |
| 1228 | 18 - two 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 |
|
5526
df3f553fa414
Update documentation for Python 3 support (issue 2550968, issue 2550980).
Joseph Myers <jsm@polyomino.org.uk>
parents:
5511
diff
changeset
|
21 - requires *no* additional support software - python (2.7 or 3.4+) is |
|
2223
9b447ac40be3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2138
diff
changeset
|
22 enough to get you going |
|
2138
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
1649
diff
changeset
|
23 - easy to set up higher-performance storage backends like sqlite_, |
|
3935
1dab48842cbd
Throwing up hands in resignation and finally deleting the metakit backend.
Richard Jones <richard@users.sourceforge.net>
parents:
3839
diff
changeset
|
24 mysql_ and 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* |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
27 - accessible through the web, email, command-line or Python programs |
|
740
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
28 - may be used to track bugs, features, user feedback, sales opportunities, |
| 1228 | 29 milestones, ... |
|
2259
f47ab53269cd
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2258
diff
changeset
|
30 - automatically keeps a full history of changes to issues with |
|
f47ab53269cd
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2258
diff
changeset
|
31 configurable verbosity and easy access to information about who created |
|
f47ab53269cd
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2258
diff
changeset
|
32 or last modified *any* item in the database |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
33 - issues have their own mini mailing list (nosy list) |
| 2258 | 34 - users may sign themselves up, there may be automatic signup for |
| 35 incoming email and users may handle their own password reset requests | |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
36 |
| 1228 | 37 *highly configurable* |
| 38 - web interface HTML is fully editable | |
| 39 - database schema is also fully editable (only the "user" class is required) | |
| 40 with a full set of data types (including dates and many-to-many relations) | |
| 41 across all storages available | |
| 42 - customised automatic auditors and reactors may be written that perform | |
|
2138
f76d1642014a
doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
1649
diff
changeset
|
43 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
|
44 or may veto the creation or modification of items in the database |
| 2258 | 45 - samples are provided for all manner of configuration changes and |
| 46 customisations | |
| 1228 | 47 |
| 48 *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
|
49 - 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
|
50 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
|
51 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
|
52 - 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
|
53 support them (sqlite, mysql and postgresql) |
| 1228 | 54 - indexed text searching giving fast responses to searches across all |
| 55 messages and indexed string properties | |
|
5096
e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
John Rouillard <rouilj@ieee.org>
parents:
4226
diff
changeset
|
56 - support for the Xapian or Whoosh full-text indexing engine for large trackers |
| 1228 | 57 |
| 58 *documented* | |
| 59 - documentation exists for installation, upgrading, maintenance, users and | |
| 60 customisation | |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
61 |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
62 *web interface* |
| 1228 | 63 - fully editable interfaces for listing and display of items |
| 64 - extendable to include wizards, parent/meta bug displays, ... | |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
65 - differentiates between anonymous, known and admin users |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
66 - 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
|
67 to register new users |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
68 - authentication of user registration and user-driven password resetting |
|
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
69 using email and one time keys |
|
3748
fdc9eb78d708
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
3533
diff
changeset
|
70 - may be run using WSGI or through CGI as a normal cgi script, as a |
|
5891
6e341009593b
Deprecate mod_python issue2551005
John Rouillard <rouilj@ieee.org>
parents:
5756
diff
changeset
|
71 stand-alone web server, under mod_wsgi (mod_python is deprecated) or through Zope |
|
740
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
72 - searching may be performed using many constraints, including a full-text |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
73 search of messages attached to issues |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
74 - 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
|
75 correct content-type and filename |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
76 - 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
|
77 person who made the change, but responses will go back through the nosy |
| 741 | 78 list by default |
| 2258 | 79 - flexible access control built around Permissions and Roles with assigned |
| 80 Permissions | |
| 81 - generates valid HTML4 or XHTML | |
| 82 - detects concurrent user changes | |
| 83 - saving and editing of user-defined queries which may optionally be | |
| 84 shared with other users | |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
85 |
| 741 | 86 *e-mail interface* |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
87 - 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
|
88 polling |
|
740
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
89 - 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
|
90 - 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
|
91 are sent to the list |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
92 - auto-filing of "unformatted" messages into a particular class |
|
740
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
93 - 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
|
94 intended for, and forwarded on to the nosy list |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
95 - 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
|
96 preferred in all situations) |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
97 - email packages that display threading will show issue messages correctly |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
98 threaded |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
99 - users may send in messages from multiple addresses and be associated |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
100 with the same roundup username |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
101 - built-in security features like TLS and APOP |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
102 |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
103 *command-line* |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
104 - may be used to interactively manage roundup databases |
|
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
105 - may be scripted using standard shell scripting |
|
740
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
106 - roundup's API may also be used by other Python programs - a sample is |
|
2d50d6a17617
more marketing ;)
Richard Jones <richard@users.sourceforge.net>
parents:
739
diff
changeset
|
107 provided that runs once a day and emails people their assigned issues |
|
1649
6d392197daa3
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1228
diff
changeset
|
108 - 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
|
109 generation, ...) |
|
739
c612747b1126
Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
110 |
| 3839 | 111 *xmlrpc interface* |
| 112 - 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
|
113 available at the /xmlrpc endpoint. |
| 3839 | 114 - provides same access to tracker as roundup-admin, but based on |
| 115 XMLRPC calls | |
|
5695
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
116 - see the `xmlrpc guide`_ for more details simple clients etc. |
|
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
117 |
|
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
118 *restful interface* |
|
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
119 - accessible using basic HTTP authentication at /rest starting point |
|
3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents:
5526
diff
changeset
|
120 - see the `rest guide`_ for details. |
| 3839 | 121 |
| 1228 | 122 .. _sqlite: http://www.hwaci.com/sw/sqlite/ |
|
5511
bfe8e52af1e7
more mentions of updated MySQL client module
Christof Meerwald <cmeerw@cmeerw.org>
parents:
5096
diff
changeset
|
123 .. _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
|
124 .. _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
|
125 .. _`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
|
126 .. _`rest guide`: rest.html |