Mercurial > p > roundup > code

annotate website/www/index.txt @ 7340:7b9bddda9d2d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add support for demo mode in docker. roundup/demo.py Make changes to allow exposed port in docker to be specified separately from the port that demo mode binds to. Also permit bind address specification as well. roundup/scripts/roundup_demo.py: Update required by changes in demo.py. Also move away from positional arguments to prefer flag arguments. Required for passing port and host specification. Flake8 fixes. share/man/man1/roundup-demo.1 Document use of option flags rather than positional params. Other cleanups. doc/installation.txt: Document new docker modes: demo, shell and admin. Update docs: overview section - reorg, added template info for the impatient section - added docker demo mode reference, more docs on top level demo.py use. new section on docker demo mode removed getting roundup section. folded into installing roundup. also prior for the impatient section describes how to download. install via pip in venv recommended supported method document all provided templates. not just minimal and classic. added index references. move sections around, decreased sectin depth, reformatting scripts/Docker/roundup_healthcheck: When running roundup-demo, there is no tracker spec. So default to demo if no tracker=directory args found. Prevent's docker from reporting an unhealthy container when running demo. scripts/Docker/roundup_start: implement demo, shell, admin docker modes.
author John Rouillard <rouilj@ieee.org>
date Sun, 14 May 2023 09:43:53 -0400
parents 9d82d0811a22
children 623502678b97
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.
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
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
77 The current stable version of Roundup is 2.2.0. It is a bug fix
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
78 and feature release for the 2.1.0 release
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
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
83 Some improvements from the 2.1.0 release are:
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
84
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
85 * Roundup supports dynamic and static compression of http
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
86 responses. This improves performance when a front end web
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
87 server isn't serving compressed assets.
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
88
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
89 * REST interface: supports CORS allowing Roundup to be
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
90 used by third party web sites. Origins allowed to use
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
91 REST can be specified. OpenAPI (Swagger) docs can be
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
92 added. Error handling/reporting improved.
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
93
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
94 * Dockerfile support. Docker-compose for a mysql based
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
95 tracker.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
96
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
97 * New full text search methods. SQLite FTS and PostgreSQL
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
98 full text search are supported. These allow search
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
99 expressions in addition to simple word based searches.
6439
5296d27ac97c Implementing RELEASE.txt 2.1.0b1 release
John Rouillard <rouilj@ieee.org>
parents: 6269
diff changeset
100
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
101 * Secret values in config.ini can be stored in external
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
102 files. This allows config.ini to be stored in a VCS
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
103 without exposing secrets.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
104
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
105 * Translation object added to internal database handle. This
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
106 allows auditors and extensions to provide efficient
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
107 translations.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
108
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
109 * MySQL database creation uses COLLATE utf8_general_ci
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
110
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
111 * Wsgi startup improvements (must be enabled by setting
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
112 feature flag).
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
113
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
114 * Fix crash when importing legacy Roundup tracker with long
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
115 integers.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
116
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
117 * Fix issues with Roundup unable to find supporting files
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
118 when installed via pip.
6782
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
119
a1868fe784d0 Changes for release 2.2.0.
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
120 More info on the 57 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
121
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
122 Roundup Use Cases
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
123 =================
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
124
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
125 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
126 <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
127 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
128
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
129 * 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
130 installation)
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
131 * 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
132 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
133 issue trackers)
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
134 * issue management for IETF working groups
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
135 * sales lead tracking
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
136 * 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
137 management
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
138 * weblogging (well, almost :)
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
139
5949
573b688fffeb RELEASE.txt changes checkin pre 2.0.0alpha0
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
140 ...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
141 <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
142 tracker.
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
143
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
144
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
145 Try It Out
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
146 ==========
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
147
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
148 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
149 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
150 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
151
7326
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
152 You can install using a virtual environment with pip by:
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
153
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
154 1. create a virtual environment with::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
155
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
156 python3 -m venv roundup
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
157
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
158 2. activate the environment with (assuming your shell is
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
159 sh/bash/zsh/ksh like)::
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 . roundup/bin/activate
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 3. install the latest release of Roundup with::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
164
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
165 python3 -m pip install roundup
7123
88768965868a Badge cleanup; more directions on running demo tracker
John Rouillard <rouilj@ieee.org>
parents: 7086
diff changeset
166
7326
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
167 4. create a demo tracker with::
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
168
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
169 roundup-demo
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
170
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
171 using ``./demo`` as the directory and the ``classic`` tracker.
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
172
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
173 5. load the URL printed by the demo tracker
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
174
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
175 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
176 the system python.
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
177
7327
9d82d0811a22 remove shorter.
John Rouillard <rouilj@ieee.org>
parents: 7326
diff changeset
178 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
179 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
180 your downloaded file).
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
181
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
182 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
183 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
184
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
185 * 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
186
7284
9d0fea9f3482 fix markdown formatting of unordered and ordered lists
John Rouillard <rouilj@ieee.org>
parents: 7131
diff changeset
187 3. ``cd roundup-2.2.0``
7326
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
188 4. ``python3 demo.py``
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
189
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
190 Both of these methods produce the same result.
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
191
961147f85caa Add virtualenv instant gratification
John Rouillard <rouilj@ieee.org>
parents: 7323
diff changeset
192 (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
193
7323
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
194 Origin Story
a54d7b2d3c1f Add sections to landing page.
John Rouillard <rouilj@ieee.org>
parents: 7284
diff changeset
195 ============
6456
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
196 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
197 The first `change note`_ written said:
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
198
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
199 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
200 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
201 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
202
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 5335
diff changeset
203 .. _`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
204 .. _`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
205 .. _`its own set of docs`: https://www.roundup-tracker.org/dev-docs/docs.html
Roundup Issue Tracker: http://roundup-tracker.org/