Mercurial > p > roundup > code

annotate website/www/index.txt @ 8546:c9bb470e6d38

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: update admonintion to past tense Also remove some rationale as it's no longer important.
author John Rouillard <rouilj@ieee.org>
date Wed, 25 Mar 2026 11:39:27 -0400
parents 93f9d8622111
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
1 =====================
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
2 Roundup Issue Tracker
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
3 =====================
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
4
6668
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6628
diff changeset
5 .. meta::
6627
e9d0534cbc18 Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents: 6623
diff changeset
6 :title: Roundup Issue Tracker
e9d0534cbc18 Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents: 6623
diff changeset
7 :description: A simple-to-use and -install issue-tracking system
e9d0534cbc18 Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents: 6623
diff changeset
8 with command-line, web, REST, XML-RPC and e-mail interfaces.
7663
af720eeb7e86 doc: fix description tags on web page.
John Rouillard <rouilj@ieee.org>
parents: 7612
diff changeset
9 Adaptable to many use cases. Allows you to customize the look
6627
e9d0534cbc18 Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents: 6623
diff changeset
10 and feel and implement different workflows.
6668
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6628
diff changeset
11 :og\:type: website
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6628
diff changeset
12 :og\:url: https://www.roundup-tracker.org/
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6628
diff changeset
13 :og\:title: Roundup Issue Tracker
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6628
diff changeset
14 :og\:description: A simple-to-use and -install issue-tracking system
6627
e9d0534cbc18 Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents: 6623
diff changeset
15 with command-line, web, REST, XML-RPC and e-mail interfaces.
7663
af720eeb7e86 doc: fix description tags on web page.
John Rouillard <rouilj@ieee.org>
parents: 7612
diff changeset
16 Adaptable to many use cases. Allows you to customize the look
6627
e9d0534cbc18 Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents: 6623
diff changeset
17 and feel and implement different workflows.
6668
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6628
diff changeset
18 :og\:image: https://www.roundup-tracker.org/_images/index_logged_out.png
6627
e9d0534cbc18 Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents: 6623
diff changeset
19
6263
3a851df879cd Remove doc dependency sphinxcontrib-cheeseshop.
John Rouillard <rouilj@ieee.org>
parents: 6225
diff changeset
20 .. raw:: html
3a851df879cd Remove doc dependency sphinxcontrib-cheeseshop.
John Rouillard <rouilj@ieee.org>
parents: 6225
diff changeset
21
7467
92fb16035d92 Reclass release info badge block on home page.
John Rouillard <rouilj@ieee.org>
parents: 7463
diff changeset
22 <div class="release_info news">
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
23 <!-- package version/pypi download -->
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
24 <a
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
25 href="https://pypi.org/project/roundup/#files">
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
26 <span style="padding-inline-end: 1.75ch">Download:</span>
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
27 <img style="vertical-align: text-top"
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
28 src="https://img.shields.io/pypi/v/roundup?color=blue&label=Current%20Version&cacheSeconds=86400"
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
29 alt="Display current version of Roundup on PyPI."
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
30 height="18" width="127">
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
31 </a>
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
32
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
33 <!-- supported python versions: <img src="https://shields.io/pypi/pyversions/roundup"> -->
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
34 <!-- license: <img src="https://img.shields.io/pypi/l/roundup"> -->
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
35 <!-- changes since 2.5.0 <img src="https://img.shields.io/github/commits-since/roundup-tracker/roundup/2.5.0/master?sort=semver"> -->
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
36 <!-- status beta, stable, mature.... <img src="https://img.shields.io/pypi/status/roundup"> -->
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
37 <!-- mozilla observatory <img src="https://img.shields.io/mozilla-observatory/grade/www.roundup-tracker.org?publish"> -->
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
38 <!-- commits from last named release: <img alt="GitHub commits difference between two branches/tags/commits" src="https://img.shields.io/github/commits-difference/roundup-tracker/roundup?base=2.5.0&head=master">a -->
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
39 <!-- newest tag by date - use for alpha/beta release notifications?
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
40 <img alt="GitHub tag (latest by date)" src="https://img.shields.io/github/v/tag/roundup-tracker/roundup"> -->
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
41
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
42 <!-- downloads/month -->
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
43 <a style="display:block; margin-block-start: 0.5em;"
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
44 href="https://pypistats.org/packages/roundup">
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
45 <span style="padding-inline-start: 10.75ch"></span>
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
46 <img
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
47 src="https://img.shields.io/badge/dynamic/json?color=blue&label=Downloads%2FMonth&cacheSeconds=86400&query=data.last_month&url=https%3A%2F%2Fpypistats.org%2Fapi%2Fpackages%2Froundup%2Frecent"
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
48 alt="Badge displaying number of downloads per month."
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
49 height="18" width="127">
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
50 </a>
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
51 <a style="display:block; margin-block-start: 0.5em;"
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
52 href="https://hub.docker.com/r/rounduptracker/roundup">
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
53 <span style="padding-inline-start: 10.75ch"></span>
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
54 <img
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
55 src="https://img.shields.io/docker/image-size/rounduptracker/roundup?label=Docker%20Size"
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
56 alt="Graphic displaying size of newest docker image on hub.docker.com."
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
57 height="18" width="127">
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
58 </a>
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
59
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
60 <!-- build status -->
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
61 <a
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
62 style="display:block; margin-block-start: 1em;"
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
63 href="https://github.com/roundup-tracker/roundup/actions?query=workflow%3Aroundup-ci++">
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
64 <span>Build Status:</span>
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
65 <img
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
66 src="https://github.com/roundup-tracker/roundup/actions/workflows/ci-test.yml/badge.svg"
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
67 alt="Status of primary regression test job on github."
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
68 height="18" width="127"><br>
6927
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
69 </a>
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
70 </div>
87c0273853a2 add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents: 6796
diff changeset
71
7599
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
72 Roundup is an issue-tracking system that boasts a user-friendly
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
73 interface and easy installation process. It offers a range of
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
74 interfaces, including command-line, web, REST, XML-RPC, and e-mail,
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
75 making it a versatile solution for issue tracking. The system is based
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
76 on the award-winning design by Ka-Ping Yee, which emerged victorious
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
77 in the Software Carpentry “Track” design competition.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
78
7599
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
79 Roundup is highly customizable, allowing users to tailor the system to
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
80 their specific needs and preferences.
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
81
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
82 The latest stable version of Roundup is 2.5.0, which includes bug
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
83 fixes and additional features compared to the previous 2.4.0 release.
7461
dcd4ee924dc2 Add supported python versions and Python 2 support status to home page.
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
84
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
85 Roundup is compatible with Python 3.7+.
7461
dcd4ee924dc2 Add supported python versions and Python 2 support status to home page.
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
86
dcd4ee924dc2 Add supported python versions and Python 2 support status to home page.
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
87 .. admonition:: Python 2 Support
dcd4ee924dc2 Add supported python versions and Python 2 support status to home page.
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
88
8546
c9bb470e6d38 doc: update admonintion to past tense
John Rouillard <rouilj@ieee.org>
parents: 8476
diff changeset
89 Python 2 support ended with release 2.4.0 (July 2024).
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
90 Use Python 3 for the deployment of new trackers.
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
91 Existing trackers should be `upgraded to use Python 3.
7612
e3f5edcfbbac docs: reword to eliminate bare url in prose.
John Rouillard <rouilj@ieee.org>
parents: 7610
diff changeset
92 <docs/upgrading.html#python-3-support-info>`_
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
93
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
94 Release Highlights
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
95 ==================
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
96
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
97 Some improvements from the 2.4.0 release are:
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
98
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
99 * **XSS vulnerability with devel and responsive templates fixed**
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
100
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
101 Just before release an XSS security issue with trackers based on
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
102 the devel or responsive templates was discovered. The `updating
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
103 directions`_ include instructions on fixing this issue with the
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
104 html templates from earlier releases. (CVE-2025-53865)
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
105
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
106 .. _`updating directions`: docs/upgrading.html#cve-2025-53865
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
107
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
108 * **The property/field advanced search expression feature has been
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
109 enhanced and documented.**
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
110
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
111 Search expressions are usually built using the
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
112 expression editor on the search page. They can be built manually
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
113 by modifying the search URL but the RPN search expression format
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
114 was undocumented. Errors in expressions could return results that
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
115 didn't match the user's intent. This release documents the RPN
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
116 expression syntax, adds basic expression error detection, and
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
117 improves error reporting.
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
118
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
119 * **The default hash method for password storage is more secure.**
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
120
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
121 We use PBKDF2 with SHA512 (was SHA1). With this change you can
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
122 lower the value of password_pbkdf2_default_rounds in your
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
123 tracker's config.ini. Check the upgrading documentation for more
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
124 info. (Note this may cause longer authentication times, the
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
125 upgrade doc describes how to downgrade the hash method if required.)
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
126
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
127 * **Roundup's session token is now prefixed with the magic
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
128 ``__Secure__`` tag when using HTTPS.**
6439
5296d27ac97c Implementing RELEASE.txt 2.1.0b1 release
John Rouillard <rouilj@ieee.org>
parents: 6269
diff changeset
129
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
130 This adds another layer of protection in addition to the
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
131 existing ``Secure`` property that comes with the session cookie.
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
132
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
133 * **Data authorization can be done at the database level speeding up
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
134 display of index pages.**
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
135
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
136 Roundup verifies the user's authorization for the data fetched
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
137 from the database after retrieving data from the database. A new
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
138 optional ``filter`` argument has been added to Permission
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
139 objects. When the administrator supplies a filter function, it
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
140 can boost performance with SQL server databases by pushing
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
141 selection criteria to the database. By offloading some
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
142 permission checks to the database, less data is retrieved from
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
143 the database. This leads to quicker display of index pages with
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
144 reduced CPU and network traffic.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
145
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
146 * **The REST endpoint can supply binary data (images, pdf, ...) to
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
147 its clients.**
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
148
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
149 Requesting binary data from a REST endpoint has been a
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
150 hassle. Since JSON can't handle binary data, images (and other
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
151 binary data) need to be encoded. This makes them significantly
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
152 larger. The workaround was to use a non-REST endpoint for fetching
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
153 non-text attachments. This update lets the REST endpoint return
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
154 raw message or file content data. You can utilize the
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
155 ``binary_content`` endpoint along with an appropriate ``Accept``
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
156 header (e.g. ``image/jpeg``) in your request.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
157
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
158 * **Extract translatable strings from your tracker easily.**
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
159
8373
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
160 The ``roundup-gettext`` tool has been enhanced to extract
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
161 translatable strings from detectors and extensions. This will
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
162 simplify the process of translating your trackers.
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
163
0f2e86085a79 doc: update to reflect changes 2.4.0 -> 2.5.0.
John Rouillard <rouilj@ieee.org>
parents: 8071
diff changeset
164 More info on the 42 changes can be found in the `change notes`_.
6456
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
165
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
166 Roundup Use Cases
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
167 =================
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
168
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
169 For more information on Roundup see the :doc:`features list
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
170 <docs/features>`, :doc:`design overview <docs/design>`, and all the
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
171 other :doc:`documentation <docs>`. Roundup has been deployed for:
6456
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
172
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
173 * bug tracking and TODO list management (the classic
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
174 installation)
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
175 * customer help desk support (with a wizard for the phone
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
176 answerers, linking to networking, system and development
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
177 issue trackers)
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
178 * issue management for IETF working groups
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
179 * sales lead tracking
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
180 * conference paper submission and double-blind referee
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
181 management
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
182 * weblogging (well, almost :)
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
183 * thing management using the `GTD methodology <https://gettingthingsdone.com/>`_.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
184
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
185 ...and so on. It's been designed with :doc:`flexibility
7599
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
186 <docs/customizing>` in mind - it's not merely another bug
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
187 tracker.
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
188
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
189
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
190 Try It Out
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
191 ==========
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
192
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
193 Roundup ships with a **demo tracker** to play with - you don't need to
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
194 install Roundup. After you've unpacked the source, just run "``python
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
195 demo.py``" and load up the URL it prints out!
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
196
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
197 Follow the source gratification mode with these steps (change the
8476
93f9d8622111 doc: update styles to WCAG AAA; add accessibility statement; reword
John Rouillard <rouilj@ieee.org>
parents: 8373
diff changeset
198 ``-2.6.0`` version identifier to match the version of Roundup you want
93f9d8622111 doc: update styles to WCAG AAA; add accessibility statement; reword
John Rouillard <rouilj@ieee.org>
parents: 8373
diff changeset
199 to use).
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
200
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
201 1. ``python3 -m pip download roundup``
8476
93f9d8622111 doc: update styles to WCAG AAA; add accessibility statement; reword
John Rouillard <rouilj@ieee.org>
parents: 8373
diff changeset
202 2. ``tar -xzvf roundup-2.6.0.tar.gz``
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
203
7994
22faea43c5b0 make python untar command into a scrollable pre section.
John Rouillard <rouilj@ieee.org>
parents: 7663
diff changeset
204 * if you don't have a tar command (e.g windows), use::
22faea43c5b0 make python untar command into a scrollable pre section.
John Rouillard <rouilj@ieee.org>
parents: 7663
diff changeset
205
8476
93f9d8622111 doc: update styles to WCAG AAA; add accessibility statement; reword
John Rouillard <rouilj@ieee.org>
parents: 8373
diff changeset
206 python -c "import tarfile, sys; tarfile.open(sys.argv[1]).extractall();" roundup-2.6.0.tar.gz
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
207
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
208
8476
93f9d8622111 doc: update styles to WCAG AAA; add accessibility statement; reword
John Rouillard <rouilj@ieee.org>
parents: 8373
diff changeset
209 3. ``cd roundup-2.6.0``
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
210 4. ``python3 demo.py``
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
211
7500
c550b338616a Link to docker support from main web index. Docker support changes.
John Rouillard <rouilj@ieee.org>
parents: 7478
diff changeset
212 (The source download can also be used to `create a custom Docker
c550b338616a Link to docker support from main web index. Docker support changes.
John Rouillard <rouilj@ieee.org>
parents: 7478
diff changeset
213 image <docs/installation.html#docker-support>`_.)
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
214
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
215 Alternatively, you can install using a virtual environment with pip
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
216 by:
7326
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
217
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
218 1. create a virtual environment with::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
219
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
220 python3 -m venv roundup
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
221
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
222 2. activate the environment with (assuming your shell is
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
223 sh/bash/zsh/ksh like)::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
224
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
225 . roundup/bin/activate
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
226
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
227 3. install the latest release of Roundup with::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
228
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
229 python3 -m pip install roundup
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
230
7326
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
231 4. create a demo tracker with::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
232
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
233 roundup-demo
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
234
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
235 using ``./demo`` as the directory and the ``classic`` tracker.
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
236
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
237 5. load the URL printed by the demo tracker
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
238
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
239 6. when you are done, use `deactivate` to return your shell to using
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
240 the system python.
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
241
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
242 Both of these methods produce the same result.
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
243
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
244 Origin Story
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
245 ============
6456
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
246 Roundup was originally released as version 0.1.1 in late August, 2001.
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
247 The first `change note`_ written said:
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
248
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
249 Needed a bug tracking system. Looked around. Tried to install many Perl-based systems, to no avail.
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
250 Got tired of waiting for Roundup to be released. Had just finished major product project, so needed
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
251 something different for a while. Roundup here I come...
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
252
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
253 .. _`download`: https://pypi.org/project/roundup/
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
254 .. _`change notes`: https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt
4829
b77ef61a844e Fix link to CHANGES.txt to avoid file download
anatoly techtonik <techtonik@gmail.com>
parents: 4789
diff changeset
255 .. _`change note`: https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt
6269
92cc82788f83 Replace http:....roundup-tracker.org with https.
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
256 .. _`its own set of docs`: https://www.roundup-tracker.org/dev-docs/docs.html
Roundup Issue Tracker: http://roundup-tracker.org/