Mercurial > p > roundup > code

annotate website/www/index.txt @ 8264:09e8d1a4c796

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: clarify wording, fix index, add superseder link Make superseder, messages etc. properties index entries point to the right place. Link to description of using Superseder in the original overview. fix bad wording on boolean properties.
author John Rouillard <rouilj@ieee.org>
date Wed, 08 Jan 2025 11:39:54 -0500
parents a4cb4e75d4e9
children 0f2e86085a79
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"> -->
8069
4f07d7835019 build: some work from RELEASE.txt for 2.4.0 release.
John Rouillard <rouilj@ieee.org>
parents: 7996
diff changeset
35 <!-- changes since 2.4.0 <img src="https://img.shields.io/github/commits-since/roundup-tracker/roundup/2.4.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"> -->
8069
4f07d7835019 build: some work from RELEASE.txt for 2.4.0 release.
John Rouillard <rouilj@ieee.org>
parents: 7996
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.4.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
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
82 The latest stable version of Roundup is 2.4.0, which includes bug
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
83 fixes and additional features compared to the previous 2.3.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
7599
2c6acd503f00 docs: rewrite index page using GPT based tool.
John Rouillard <rouilj@ieee.org>
parents: 7530
diff changeset
85 Roundup is compatible with Python 2.7.12+ or 3.6+.
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
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
89 Python 2 support ends with release 2.4.0 (July 2024).
7996
7b71a9521998 commit to 2025 as sunset date for python2 support.
John Rouillard <rouilj@ieee.org>
parents: 7994
diff changeset
90 Several Continuous Integration (CI) services are
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
91 discontinuing their resources for testing with Python 2.
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
92 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
93 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
94 <docs/upgrading.html#python-3-support-info>`_
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
95
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
96 Release Highlights
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
97 ==================
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
98
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
99 Some improvements from the 2.3.0 release are:
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
100
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
101 * three CVE's have been fixed. One requires changes to your
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
102 tracker's home directory. The other two are fixed by
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
103 installing 2.4.0. See
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
104 https://www.roundup-tracker.org/docs/security.html for
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
105 details and instructions on how to fix these in 2.4.0 and
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
106 earlier releases.
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
107
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
108 * new classhelper component thanks to a team of students
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
109 from CS682 at U-Mass Boston. This fixes many issues with
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
110 the old classhelper. It is implemented as a web-component
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
111 and needs REST interface access. It will fall back to the
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
112 classic classhelper if REST is not available or if the
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
113 browser does not support web-components.
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
114
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
115 * fix Windows Python installation using pip. It used to go
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
116 into an infinite loop during install or download. Also fix
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
117 installation of shared files (templates) so roundup-admin
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
118 can find them.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
119
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
120 * using ``@current_user`` as a value in a search URL for a
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
121 user property will use the current logged in user. Now you
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
122 can share searches like: "My issues" as "my" will become
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
123 the current logged in user.
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
124
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
125 * login failures to the REST/XML-RPC interfaces are now rate
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
126 limited to limit password guessing attacks.
6439
5296d27ac97c Implementing RELEASE.txt 2.1.0b1 release
John Rouillard <rouilj@ieee.org>
parents: 6269
diff changeset
127
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
128 * utf8mb4 is the default charset for MySQL. This requires
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
129 migrating your database using the mysql client. You can
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
130 choose to keep the older character set in config.ini.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
131
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
132 * PostgreSQL services defined in pg_service.conf can be
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
133 used. PostgreSQL schemas are supported to eliminate the
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
134 need for the roundup user to have database
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
135 creation/deletion privileges.
7442
623502678b97 2.3.0b1 release changes
John Rouillard <rouilj@ieee.org>
parents: 7327
diff changeset
136
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
137 * fix out of memory issue when importing larger trackers
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
138 into PostgreSQL.
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
139
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
140 * multiple roundup-admin improvements: display protected
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
141 properties (like creation date), better formatting of
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
142 output, command history. Also on windows, pyreadline3 is
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
143 supported to provide an editable interactive command line.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
144
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
145 * an experimental wsgi performance improvement in 2.3.0 is
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
146 now now the default and is opt-out.
7442
623502678b97 2.3.0b1 release changes
John Rouillard <rouilj@ieee.org>
parents: 7327
diff changeset
147
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
148 * new template functions: utils.readfile and
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
149 utils.expandfile. Javascript that is included in the
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
150 Python core will be moved to external files and be able to
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
151 have values from Roundup substituted in the Javascript.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
152
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
153 * allow content-type of a template to be set from inside the
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
154 template. This allows returning json or xml from a
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
155 template without a .json or .xml extention.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
156
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
157 * fix import/export on windows to use Unix style line
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
158 endings fixing export/import on Windows and making exports
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
159 portable across platforms.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
160
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
161 More info on the 79 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
162
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
163 Roundup Use Cases
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
164 =================
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
165
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
166 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
167 <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
168 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
169
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
170 * 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
171 installation)
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
172 * 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
173 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
174 issue trackers)
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
175 * issue management for IETF working groups
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
176 * sales lead tracking
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
177 * 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
178 management
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
179 * weblogging (well, almost :)
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
180 * 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
181
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
182 ...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
183 <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
184 tracker.
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
185
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
186
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
187 Try It Out
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 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
191 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
192 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
193
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
194 Follow the source gratification mode with these steps (change the
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
195 ``-2.4.0`` version identifier to match your downloaded file).
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
196
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
197 1. ``python3 -m pip download roundup``
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
198 2. ``tar -xzvf roundup-2.4.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
199
7994
22faea43c5b0 make python untar command into a scrollable pre section.
John Rouillard <rouilj@ieee.org>
parents: 7663
diff changeset
200 * 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
201
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
202 python -c "import tarfile, sys; tarfile.open(sys.argv[1]).extractall();" roundup-2.4.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
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
204
8071
a4cb4e75d4e9 final changes for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 8069
diff changeset
205 3. ``cd roundup-2.4.0``
7478
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
206 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
207
7500
c550b338616a Link to docker support from main web index. Docker support changes.
John Rouillard <rouilj@ieee.org>
parents: 7478
diff changeset
208 (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
209 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
210
e8d2a4bca16a Update index. Add "track your issues your way" tag line and...
John Rouillard <rouilj@ieee.org>
parents: 7467
diff changeset
211 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
212 by:
7326
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
213
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
214 1. create a virtual environment with::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
215
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
216 python3 -m venv roundup
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 2. activate the environment with (assuming your shell is
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
219 sh/bash/zsh/ksh like)::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
220
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
221 . roundup/bin/activate
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
222
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
223 3. install the latest release of Roundup with::
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 python3 -m pip install roundup
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
226
7326
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
227 4. create a demo tracker 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 roundup-demo
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
230
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
231 using ``./demo`` as the directory and the ``classic`` tracker.
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 5. load the URL printed by the demo tracker
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 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
236 the system python.
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
237
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
238 Both of these methods produce the same result.
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
239
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
240 Origin Story
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
241 ============
6456
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
242 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
243 The first `change note`_ written said:
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
244
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
245 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
246 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
247 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
248
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
249 .. _`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
250 .. _`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
251 .. _`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
252 .. _`its own set of docs`: https://www.roundup-tracker.org/dev-docs/docs.html
Roundup Issue Tracker: http://roundup-tracker.org/