Mercurial > p > roundup > code

comparison doc/features.txt @ 8390:00d4cbce319c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: fix formatting, typos.
author John Rouillard <rouilj@ieee.org>
date Sat, 12 Jul 2025 20:52:30 -0400
parents 15b99d4cd94c
children a0f9ef08c36c
comparison
equal deleted inserted replaced
8389:15b99d4cd94c 8390:00d4cbce319c
8 Roundup Features 8 Roundup Features
9 ================ 9 ================
10 10
11 Roundup is an easy-to-use and -install issue-tracking system with 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 12 web, e-mail and command-line interfaces. Based on the winning design
13 from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition. 13 from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design
14 competition.
14 15
15 **Installation and Setup** 16 **Installation and Setup**
16 17
17 - Start using the software in `instant-gratification (demo) mode`_ with 18 - Start using the software in `instant-gratification (demo) mode`_ with
18 ``python demo.py`` or `a Docker container`_ in under 5 minutes. 19 ``python demo.py`` or `a Docker container`_ in under 5 minutes.
32 33
33 **Issue Tracking and Management** 34 **Issue Tracking and Management**
34 35
35 - Manage your issues your way. Handle bugs, features, milestones, 36 - Manage your issues your way. Handle bugs, features, milestones,
36 user feedback, fleet maintenance, office issues etc. 37 user feedback, fleet maintenance, office issues etc.
38 - Issues become a mini mailing list to keep everyone informed.
37 - Searches on specific properties (e.g. open issues with a high 39 - Searches on specific properties (e.g. open issues with a high
38 priority) can be saved and reused or shared with outer users. 40 priority) can be saved and reused or shared with other users.
39 - Full Text Search for quick searches across messages. 41 - Full Text Search for quick searches across messages.
40 - Keeps a detailed history of issue changes. 42 - Keeps a detailed history of issue changes.
41 - Issues become a mini mailing list to keep everyone informed.
42 - Email is a first class method for interacting with issues. 43 - Email is a first class method for interacting with issues.
43 44
44 **Scalability and Performance** 45 **Scalability and Performance**
45 46
46 - Default trackers use simple HTML with low resource requirements. 47 - Default trackers use simple HTML with low resource requirements.
75 **Documentation and User Management** 76 **Documentation and User Management**
76 77
77 - Users can sign up through the web interface or new user creation 78 - Users can sign up through the web interface or new user creation
78 can be limited to admin users. 79 can be limited to admin users.
79 - Can use an `external user database`_ (LDAP, password file) 80 - Can use an `external user database`_ (LDAP, password file)
80 - Self-server password reset for users via email. 81 - Self-serve password reset for users via email.
81 82
82 **Email Integration and Automation** 83 **Email Integration and Automation**
83 84
84 - Update issues via email with new messages and the ability to 85 - Update issues via email with new messages and the ability to
85 change properties of issues (e.g. close an issue). 86 change properties of issues (e.g. close an issue).
95 - Python programs can use the Roundup Python API to manage/automate issues. 96 - Python programs can use the Roundup Python API to manage/automate issues.
96 - Sample scripts provided for various tasks. 97 - Sample scripts provided for various tasks.
97 98
98 **Remote Access Interfaces** 99 **Remote Access Interfaces**
99 100
101 - `RESTful API`_ accessible with basic HTTP authentication or optional JWT.
100 - `XMLRPC interface`_ for remote tracker access with basic 102 - `XMLRPC interface`_ for remote tracker access with basic
101 HTTP authentication. 103 HTTP authentication.
102 - `RESTful API`_ accessible with basic HTTP authentication or optional JWT.
103 - Configurable CORS support for third-party web pages. 104 - Configurable CORS support for third-party web pages.
104 - Ability to generate and authenticate JSON Web Tokens (JWT). 105 - Ability to generate and authenticate JSON Web Tokens (JWT).
105 106
106 .. _`auditors and reactors`: reference.html#auditor-or-reactor 107 .. _`auditors and reactors`: reference.html#auditor-or-reactor
107 .. _`customize`: customizing.html 108 .. _`customize`: customizing.html
Roundup Issue Tracker: http://roundup-tracker.org/