Skip to content

Commit a5d0b1e

Browse files
committed
Update index. Add "track your issues your way" tag line and...
Add description of benefits to some of the noteworthy changes. Add GTD "thing management" from old email in the 1.6 time period. Reverse order of fast gratification so source directory is first then venv install. Match the first line that says you don't have to install.
1 parent 52dfcd5 commit a5d0b1e

File tree

1 file changed

+36
-24
lines changed

1 file changed

+36
-24
lines changed

website/www/index.txt

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ command-line, web, REST, XML-RPC and e-mail interfaces. It is based
7474
on the winning design from Ka-Ping Yee in the Software Carpentry
7575
"Track" design competition.
7676

77+
It is designed to be customised so you can "track your issues your
78+
way".
79+
7780
The current stable version of Roundup is 2.3.0b2. It is a bug fix and
7881
feature release for the 2.2.0 release.
7982

@@ -92,10 +95,11 @@ Release Highlights
9295

9396
Some improvements from the 2.2.0 release are:
9497

95-
* Dockerfile demo mode implemented.
98+
* Dockerfile demo mode implemented. This allows quick evaluation as
99+
well as the ability to spin up a configured tracker to customise.
96100

97101
* SQLite backends can use WAL mode to reduce blocking between readers
98-
and writers.
102+
and writers improving concurrent use.
99103

100104
* Redis can be used for session database with SQLite and dbm
101105
backends. Provides a major performance improvement.
@@ -106,33 +110,36 @@ Some improvements from the 2.2.0 release are:
106110
* Postgres full text index can now be enabled.
107111

108112
* Modifications to in-reply-to threading when there are multiple
109-
matches.
113+
matches results in more predictable handling of messages.
110114

111115
* Many updates to documentation to make it scannable, useful and
112116
work on mobile.
113117

114118
* Admin documentation includes a section on setting up Content
115-
Security Policy (CSP)
119+
Security Policy (CSP) to better secure your Roundup trackers.
116120

117121
* REST now allows rate limiting headers to be accessed by client
118122
JavaScript.
119123

120124
* Default number of rounds for PBKDF2 updated to 2M to account for
121125
improvements in password crackers and CPU power.
122126

123-
* Support PBKDF2 with SHA512 for password storage
127+
* Support PBKDF2 with SHA512 for password storage to improve
128+
resistance to password crackers.
124129

125130
* Deprecate SSHA password hash function.
126131

127132
* roundup-admin reindex can be done in batches to manage load
128133
incurred by reindexing.
129134

130135
* roundup-admin can list available templates and their installed
131-
locations.
136+
locations. This is useful when installing via pip or in a docker
137+
container as supporting files are not stored in the usual locations
138+
like /usr/share/roundup.
132139

133-
* Crash fixes in detector handling, configuration handling,
140+
* Crash fixes in detector handling and configuration handling.
134141

135-
More info on the 51 changes can be found in the `change note`_.
142+
More info on the 51 changes can be found in the `change notes`_.
136143

137144
Roundup Use Cases
138145
=================
@@ -150,7 +157,8 @@ other :doc:`documentation <docs>`. Roundup has been deployed for:
150157
* sales lead tracking
151158
* conference paper submission and double-blind referee
152159
management
153-
* weblogging (well, almost :)
160+
* weblogging (well, almost :)
161+
* thing management using the `GTD methodology <https://gettingthingsdone.com/>`_.
154162

155163
...and so on. It's been designed with :doc:`flexibility
156164
<docs/customizing>` in mind - it's not just another bug
@@ -164,7 +172,24 @@ Roundup ships with a **demo tracker** to play with - you don't need to
164172
install Roundup. After you've unpacked the source, just run "``python
165173
demo.py``" and load up the URL it prints out!
166174

167-
You can install using a virtual environment with pip by:
175+
Follow the source gratification mode with these steps (change the
176+
``-2.3.0`` version identifier to match your downloaded file).
177+
178+
1. ``python3 -m pip download roundup``
179+
2. ``tar -xzvf roundup-2.3.0.tar.gz``
180+
181+
* if you don't have a tar command (e.g windows), use:
182+
``python -c 'import tarfile; tarfile.open(sys.argv[1]).extractall();' roundup-2.3.0.tar.gz``
183+
184+
185+
3. ``cd roundup-2.3.0``
186+
4. ``python3 demo.py``
187+
188+
(The source download can also be used to create a custom Docker
189+
image.)
190+
191+
Alternatively, you can install using a virtual environment with pip
192+
by:
168193

169194
1. create a virtual environment with::
170195

@@ -190,22 +215,8 @@ You can install using a virtual environment with pip by:
190215
6. when you are done, use `deactivate` to return your shell to using
191216
the system python.
192217

193-
Or choose the source directory gratification mode to run the demo
194-
with these steps (change the ``-2.2.0`` version identifier to match
195-
your downloaded file).
196-
197-
1. ``python3 -m pip download roundup``
198-
2. ``tar -xzvf roundup-2.2.0.tar.gz``
199-
200-
* 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.
201-
202-
3. ``cd roundup-2.2.0``
203-
4. ``python3 demo.py``
204-
205218
Both of these methods produce the same result.
206219

207-
(The source download can also be used to create a Docker image.)
208-
209220
Origin Story
210221
============
211222
Roundup was originally released as version 0.1.1 in late August, 2001.
@@ -216,5 +227,6 @@ The first `change note`_ written said:
216227
something different for a while. Roundup here I come...
217228

218229
.. _`download`: https://pypi.org/project/roundup/
230+
.. _`change notes`: https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt
219231
.. _`change note`: https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt
220232
.. _`its own set of docs`: https://www.roundup-tracker.org/dev-docs/docs.html

0 commit comments

Comments
 (0)