Mercurial > p > roundup > code
annotate website/www/index.txt @ 7443:51fc06fabcee 2.3.0b2
Changes for roundup release 2.3.0b2
I missed changing announcements.txt so the b1 release has the 2.2.0
release announcment when I uploaded to test.pipi.org.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 31 May 2023 19:44:02 -0400 |
| parents | 623502678b97 |
| children | dcd4ee924dc2 |
| 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. |
|
e9d0534cbc18
Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents:
6623
diff
changeset
|
9 Adaptable to many uses cases. Allows you to customise the look |
|
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. |
|
e9d0534cbc18
Add opengraph fields and other seo tweaks.
John Rouillard <rouilj@ieee.org>
parents:
6623
diff
changeset
|
16 Adaptable to many uses cases. Allows you to customise the look |
|
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 |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
22 <div class="release_info note"> |
|
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"> --> |
|
87c0273853a2
add build status badge and align badges into block.
John Rouillard <rouilj@ieee.org>
parents:
6796
diff
changeset
|
35 <!-- changes since 2.2.0 <img src="https://img.shields.io/github/commits-since/roundup-tracker/roundup/2.2.0/master?sort=semver"> --> |
|
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"> --> |
|
7123
88768965868a
Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents:
7086
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.2.0&head=master">a --> |
|
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 |
|
5949
573b688fffeb
RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
72 Roundup is a simple-to-use and -install issue-tracking system with |
|
6623
aa52c5e114b2
highlight rest and xml-rpc support
John Rouillard <rouilj@ieee.org>
parents:
6456
diff
changeset
|
73 command-line, web, REST, XML-RPC and e-mail interfaces. It is based |
|
aa52c5e114b2
highlight rest and xml-rpc support
John Rouillard <rouilj@ieee.org>
parents:
6456
diff
changeset
|
74 on the winning design from Ka-Ping Yee in the Software Carpentry |
|
aa52c5e114b2
highlight rest and xml-rpc support
John Rouillard <rouilj@ieee.org>
parents:
6456
diff
changeset
|
75 "Track" design competition. |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
76 |
|
7443
51fc06fabcee
Changes for roundup release 2.3.0b2
John Rouillard <rouilj@ieee.org>
parents:
7442
diff
changeset
|
77 The current stable version of Roundup is 2.3.0b2. It is a bug fix |
| 7442 | 78 and feature release for the 2.2.0 release |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
79 |
|
7323
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
80 Release Highlights |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
81 ================== |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
82 |
| 7442 | 83 Some improvements from the 2.2.0 release are: |
| 84 | |
| 85 * Dockerfile demo mode implemented. | |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
86 |
| 7442 | 87 * SQLite backends can use WAL mode to reduce blocking between readers |
| 88 and writers. | |
| 89 | |
| 90 * Redis can be used for session database with SQLite and dbm | |
| 91 backends. Provides a major performance improvement. | |
|
5949
573b688fffeb
RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
92 |
| 7442 | 93 * roundup-mailgw can use OAUTH authentication to SMTP |
| 94 server. (roundup-mailgw command line options changed as a result.) | |
| 95 | |
| 96 * Postgres full text index can now be enabled. | |
|
5949
573b688fffeb
RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
97 |
| 7442 | 98 * Modifications to in-reply-to threading when there are multiple |
| 99 matches. | |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
100 |
| 7442 | 101 * Many updates to documentation to make it scannable, useful and |
| 102 work on mobile. | |
|
6439
5296d27ac97c
Implementing RELEASE.txt 2.1.0b1 release
John Rouillard <rouilj@ieee.org>
parents:
6269
diff
changeset
|
103 |
| 7442 | 104 * Admin documentation includes a section on setting up Content |
| 105 Security Policy (CSP) | |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
106 |
| 7442 | 107 * REST now allows rate limiting headers to be accessed by client |
| 108 javascript. | |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
109 |
| 7442 | 110 * Default number of rounds for PBKDF2 updated to 2M to account for |
| 111 improvements in password crackers and CPU power. | |
| 112 | |
| 113 * Support PBKDF2 with SHA512 for password storage | |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
114 |
| 7442 | 115 * Deprecate SSHA password hash function. |
| 116 | |
| 117 * roundup-admin reindex can be done in batches to managle load | |
| 118 incurred by reindexing. | |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
119 |
| 7442 | 120 * roundup-admin can list avaailable templates and their installed |
| 121 locations. | |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
122 |
| 7442 | 123 * Crash fixes in detector handling, configuration handling, |
|
6782
a1868fe784d0
Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents:
6668
diff
changeset
|
124 |
| 7442 | 125 More info on the 51 changes can be found in the `change note`_. |
|
6456
cbc18a8bc61f
Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
126 |
|
7323
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
127 Roundup Use Cases |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
128 ================= |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
129 |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
130 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
|
131 <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
|
132 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
|
133 |
|
7284
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
134 * 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
|
135 installation) |
|
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
136 * 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
|
137 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
|
138 issue trackers) |
|
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
139 * issue management for IETF working groups |
|
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
140 * sales lead tracking |
|
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
141 * 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
|
142 management |
|
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
143 * weblogging (well, almost :) |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
144 |
|
5949
573b688fffeb
RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
145 ...and so on. It's been designed with :doc:`flexibility |
|
573b688fffeb
RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
146 <docs/customizing>` in mind - it's not just another bug |
|
7323
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
147 tracker. |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
148 |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
149 |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
150 Try It Out |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
151 ========== |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
152 |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
153 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
|
154 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
|
155 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
|
156 |
|
7326
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
157 You can install using a virtual environment with pip by: |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
158 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
159 1. create a virtual environment with:: |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
160 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
161 python3 -m venv roundup |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
162 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
163 2. activate the environment with (assuming your shell is |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
164 sh/bash/zsh/ksh like):: |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
165 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
166 . roundup/bin/activate |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
167 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
168 3. install the latest release of Roundup with:: |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
169 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
170 python3 -m pip install roundup |
|
7123
88768965868a
Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents:
7086
diff
changeset
|
171 |
|
7326
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
172 4. create a demo tracker with:: |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
173 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
174 roundup-demo |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
175 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
176 using ``./demo`` as the directory and the ``classic`` tracker. |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
177 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
178 5. load the URL printed by the demo tracker |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
179 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
180 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
|
181 the system python. |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
182 |
| 7327 | 183 Or choose the source directory gratification mode to run the demo |
|
7326
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
184 with these steps (change the ``-2.2.0`` version identifier to match |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
185 your downloaded file). |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
186 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
187 1. ``python3 -m pip download roundup`` |
|
7284
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
188 2. ``tar -xzvf roundup-2.2.0.tar.gz`` |
|
7131
efb2aa271256
Prefer use of real (gnu) tar
John Rouillard <rouilj@ieee.org>
parents:
7123
diff
changeset
|
189 |
|
7284
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
190 * if you don't have a tar command, ``python -c 'import tarfile, sys; tarfile.open(sys.argv[1]).extractall();' roundup-2.2.0.tar.gz`` can be used. |
|
7131
efb2aa271256
Prefer use of real (gnu) tar
John Rouillard <rouilj@ieee.org>
parents:
7123
diff
changeset
|
191 |
|
7284
9d0fea9f3482
fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents:
7131
diff
changeset
|
192 3. ``cd roundup-2.2.0`` |
|
7326
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
193 4. ``python3 demo.py`` |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
194 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
195 Both of these methods produce the same result. |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
196 |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
197 (The source download can also be used to create a Docker image.) |
|
961147f85caa
Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents:
7323
diff
changeset
|
198 |
|
7323
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
199 Origin Story |
|
a54d7b2d3c1f
Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents:
7284
diff
changeset
|
200 ============ |
|
6456
cbc18a8bc61f
Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents:
6439
diff
changeset
|
201 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
|
202 The first `change note`_ written said: |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
203 |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
204 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
|
205 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
|
206 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
|
207 |
|
5941
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
5335
diff
changeset
|
208 .. _`download`: https://pypi.org/project/roundup/ |
|
4829
b77ef61a844e
Fix link to CHANGES.txt to avoid file download
anatoly techtonik <techtonik@gmail.com>
parents:
4789
diff
changeset
|
209 .. _`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
|
210 .. _`its own set of docs`: https://www.roundup-tracker.org/dev-docs/docs.html |
