Skip to content

Commit 65b3384

Browse files
committed
Minor tweaks to upgrading general directions.
Recommended using virtual env for install in step 4. Make explicit that you use the new roundup-admin for migration in step 6. Cleaned up some wording. Replaced python 3.4 with python 3.6 in supported version paragraph. Added section on running different trackers with diferent versions of Roundup via virtual envirnments.
1 parent 011008b commit 65b3384

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

doc/upgrading.txt

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
Upgrading to newer versions of Roundup
1111
======================================
1212

13-
Please read each section carefully and edit your tracker home files
13+
Please read each section carefully and edit the files in your tracker home
1414
accordingly. Note that there is information about upgrade procedures in the
1515
`administration guide`_ in the `Software Upgrade`_ section.
1616

17-
If a specific version transition isn't mentioned here (eg. 0.6.7 to 0.6.8)
17+
If a specific version transition isn't mentioned here (e.g. 0.6.7 to 0.6.8)
1818
then you don't need to do anything. If you're upgrading from 0.5.6 to
19-
0.6.8 though, you'll need to check the "0.5 to 0.6" and "0.6.x to 0.6.3"
19+
0.6.8 though, you'll need to apply the "0.5 to 0.6" and "0.6.x to 0.6.3"
2020
steps.
2121

2222
General steps:
@@ -25,24 +25,25 @@ General steps:
2525
2. Take your Roundup installation offline (web, email,
2626
cron scripts, roundup-admin etc.)
2727
3. Backup your Roundup instance
28-
4. Install a new version of Roundup
28+
4. Install the new version of Roundup (preferably in a new virtual
29+
environment)
2930
5. Make version specific changes as described below for
3031
each version transition. If you are starting at 1.5.0
31-
and installing to 2.3, you need to make the changes for **all**
32+
and installing to 2.3.0, you need to make the changes for **all**
3233
versions starting at 1.5 and ending at 2.3. E.G.
3334
1.5.0 -> 1.5.1, 1.5.1 -> 1.6.0, ..., 2.1.0 -> 2.2.0,
3435
2.2.0 -> 2.3.0.
35-
6. Run ``roundup-admin -i <tracker_home> migrate`` for
36-
**all** your trackers. This will update the database if
37-
it is required.
36+
6. Run ``roundup-admin -i <tracker_home> migrate`` using the newer
37+
version of Roundup for **all** the trackers you have
38+
upgraded. This will update the database if it is required.
3839
7. Bring your Roundup instance back online
3940
8. Test
4041

4142
**IMPORTANT** The v1.5.x releases of Roundup were the last to support
4243
Python v2.5 and v2.6. Starting with the v1.6 releases of Roundup
4344
Python version 2.7 that is newer than 2.7.2 is required to run
4445
Roundup. Starting with Roundup version 2.0.0 we also support Python 3
45-
versions newer than 3.4.
46+
versions newer than 3.6.
4647

4748
Recent release notes have the following labels:
4849

@@ -53,6 +54,12 @@ Recent release notes have the following labels:
5354
want to use
5455
* info - important possibly visible changes in how things operate
5556

57+
If you use virtual environments for your installation, you can run
58+
trackers with different versions of Roundup. So you can have one tracker
59+
using version 2.2.0 and another tracker using version 1.6.1. This
60+
allows you to upgrade trackers one at a time rather than having to
61+
upgrade all your trackers at once.
62+
5663
Contents:
5764

5865
.. contents::

0 commit comments

Comments
 (0)