changeset 7438:116ea5ce06ab

issue2551269: Add warning abut Python 2 support lifetime GitHub CI no longer supports python2.
author John Rouillard <rouilj@ieee.org>
date Tue, 30 May 2023 14:47:10 -0400
parents 0d9f704a7ef2
children f7dc37df61b7
files CHANGES.txt doc/installation.txt doc/upgrading.txt
diffstat 3 files changed, 19 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/CHANGES.txt	Mon May 29 20:29:04 2023 -0400
+++ b/CHANGES.txt	Tue May 30 14:47:10 2023 -0400
@@ -103,6 +103,8 @@
 
 Features:
 
+- Add warning about limited Python 2 support lifetime to install and
+  upgrading docs. (John Rouillard)
 - Dockerfile build allows adding additional python packages via
   pip, setting UID tracker is run under. (John Rouillard)
 - issue2551140 - Added redis as a session and otk database for use
--- a/doc/installation.txt	Mon May 29 20:29:04 2023 -0400
+++ b/doc/installation.txt	Tue May 30 14:47:10 2023 -0400
@@ -172,7 +172,7 @@
 Prerequisites
 =============
 
-Roundup requires Python 2.7 or 3.6 or newer with a functioning anydbm
+Roundup requires Python 2.7 [3]_ or 3.6 or newer with a functioning anydbm
 or sqlite module. The version installed by most vendors should work if
 it meets the version requirements. If necessary, you can download the
 latest version from https://www.python.org/. It is highly recommended
@@ -288,6 +288,12 @@
 .. _Using Redis for Session Databases:
    admin_guide.html#using-redis-for-session-databases
 
+.. [3] Do not use Python 2 for new installs. The continuous
+       integration and other services used for developing Roundup
+       are dropping support for Python 2. Also optional packages
+       are dropping Python 2 support. As a result Python 2 may
+       not be supported for many more release cycles.
+
 Installing Roundup
 ==================
 
@@ -478,7 +484,7 @@
    interface. To set that up, we need to `configure a web interface`_ and
    optionally `configure an email interface`_. If you want to try your
    new tracker out, assuming the ``web`` setting in the
-   ``[tracker]`` [3]_  section of config.ini is set to
+   ``[tracker]`` [4]_  section of config.ini is set to
    ``'http://localhost:8080/support/'``, run::
 
      roundup-server support=/opt/roundup/trackers/support
@@ -497,7 +503,7 @@
    to run the server at port 1080 and bind to all ip addresses on your system.
    Then direct your web browser to ``http://your_host_name:1080/support/``.
 
-.. [3] The rest of the documentation uses the abbreviated form "tracker ::
+.. [4] The rest of the documentation uses the abbreviated form "tracker ::
        web" for specifying a section and setting.
 
 Choosing Your Template
--- a/doc/upgrading.txt	Mon May 29 20:29:04 2023 -0400
+++ b/doc/upgrading.txt	Tue May 30 14:47:10 2023 -0400
@@ -68,6 +68,14 @@
    changes in the `historical migration <upgrading-history.html>`_
    document.
 
+.. admonition:: Python 2 Support
+
+  If you are running Roundup under Python 2, you should make plans to
+  switch to Python 3. The continuous Integration (CI) and other services
+  used for developing Roundup are dropping support for Python 2. Also
+  optional packages are dropping Python 2 support. As a result Python 2
+  may not be supported for many more release cycles.
+
 Contents:
 
 .. contents::

Roundup Issue Tracker: http://roundup-tracker.org/