Merge branch 'master' into stable

docs/install/install.rst

@@ -19,6 +19,7 @@ be expensive!).
    :caption: Ubuntu Linux
 
    linux
+   linux_upgrade_from_3
    linux_upgrade_from_030
    linux_upgrade_from_02X
 
@@ -28,6 +29,7 @@ be expensive!).
    :caption: Windows Server
 
    win
+   win_upgrade_from_3
    win_upgrade_from_030
    win_upgrade_from_02X
 

docs/install/linux.rst

@@ -20,6 +20,8 @@ officially supported or tested.
 If you are upgrading an existing QATrack+ installation, please see
 one of the following pages:
 
+* :ref:`Upgrading an existing v3.x.y installation to v3.1.1.2
+  <linux_upgrading_31>`. 
 * :ref:`Upgrading an existing v0.3.0 installation to v3.1.1
   <linux_upgrading_030_to_31>`. 
 *  :ref:`Upgrading an existing v0.2.X installation to v3.1.1 <linux_upgrading_02X_to_31>`. 
@@ -91,7 +93,7 @@ QATrack+.  To checkout the code enter the following commands:
     cd web
     git clone https://github.com/qatrackplus/qatrackplus.git
     cd qatrackplus
-    git checkout v3.1.1.1
+    git checkout v3.1.1.2
 
 
 Installing a Database System

docs/install/linux_upgrade_from_030.rst

@@ -126,7 +126,7 @@ following commands:
     cd ~/web/qatrackplus
     git remote set-url origin https://github.com/qatrackplus/qatrackplus.git
     git fetch origin
-    git checkout v3.1.1.1
+    git checkout v3.1.1.2
 
 
 Setting up our Python environment (including virtualenv)

docs/install/linux_upgrade_from_3.rst

@@ -0,0 +1,129 @@
+.. _linux_upgrading_31:
+
+
+Upgrading an existing Linux v3.X.Y installation to v3.1.1.2
+===========================================================
+
+.. note::
+
+    This guide assumes you have at least a basic level of familiarity with
+    Linux and the command line.
+
+
+This guide will walk you through upgrading your existing v3.X.Y installation to
+v3.1.1.2.  If you currently have a 0.3.x version of QATrack+, you first need to
+follow the :ref:`instructions to upgrade to 3.1 <linux_upgrading_030_to_31>`,
+before carrying out these instructions.
+
+.. contents::
+    :local:
+    :depth: 2
+
+
+Take a snapshot
+~~~~~~~~~~~~~~~
+
+If your QATrack+ server exists on a virtual machine, now would be a great time
+to take a snapshot of your VM in case you need to restore it later!  Consult
+with your IT department on how to do this.
+
+
+Backup your database
+~~~~~~~~~~~~~~~~~~~~
+
+It is important you back up your database before attempting to
+upgrade. Generate a backup file for your database
+
+.. code-block:: bash
+
+    # postgres
+    sudo -u postgres pg_dump -d qatrackplus > backup-3.1.0-$(date -I).sql 
+
+    # or for MySQL
+    mysqldump --user qatrack --password=qatrackpass qatrackplus > backup-3.1.0-$(date -I).sql 
+
+
+Make sure your existing packages are up to date
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+    sudo apt update
+    sudo apt upgrade
+
+
+Check out version 3.1.1.2
+-------------------------
+
+We can now grab the latest version of QATrack+.  To checkout the code enter the
+following commands:
+
+.. code-block:: bash
+
+    cd ~/web/qatrackplus
+    git fetch origin
+    git checkout v3.1.1.2
+
+
+Updating our Python environment
+-------------------------------
+
+Activate your virtual environment:
+
+.. code-block:: bash
+
+    source ~/venvs/qatrack31/bin/activate
+
+Your command prompt should now be prefixed with `(qatrack31)`.
+
+It's also a good idea to upgrade `pip` the Python package installer:
+
+.. code-block:: bash
+
+    pip install --upgrade pip
+
+We will now install all the libraries required for QATrack+ with PostgresSQL
+(be patient, this can take a few minutes!):
+
+.. code-block:: bash
+
+    cd ~/web/qatrackplus
+    pip install -r requirements/postgres.txt
+
+or for MySQL:
+
+.. code-block:: bash
+
+    cd ~/web/qatrackplus
+    pip install -r requirements/mysql.txt
+
+
+Performing the migration
+------------------------
+
+We can now migrate the tables in our database:
+
+.. code-block:: console
+
+    python manage.py migrate
+
+
+and then we need to collect all our static media files:
+
+.. code-block:: bash
+
+    python manage.py collectstatic
+
+Restart QATrack+
+----------------
+
+Finally we need to restart QATrack+
+
+.. code-block:: console
+
+    sudo service apache2 restart
+    sudo supervisorctl reread
+    sudo supervisorctl update
+
+
+You should now be able to log into your server at http://yourserver/!

docs/install/win.rst

@@ -22,6 +22,8 @@ with SQL Server 2016 & 2019 database
 If you are upgrading an existing QATrack+ installation, please see
 one of the following pages:
 
+* :ref:`Upgrading an existing v3.x.y installation to v3.1.1.2
+  <win_upgrading_31>`. 
 * :ref:`Upgrading an existing v0.3.0 installation to v3.1.1
   <win_upgrading_030_to_31>`. 
 *  :ref:`Upgrading an existing v0.2.X installation to v3.1.1 <win_upgrading_02X_to_31>`. 
@@ -106,7 +108,7 @@ We're now ready to install all the libraries QATrack+ depends on.
     .\venvs\qatrack31\Scripts\Activate.ps1
     python -m pip install --upgrade pip
     cd qatrackplus
-    git checkout v3.1.1.1
+    git checkout v3.1.1.2
     pip install -r requirements\win.txt
 
 

docs/install/win_upgrade_from_030.rst

@@ -170,7 +170,7 @@ First we must check out the code for version 3.1.1 in a PowerShell window:
     cd C:\deploy\qatrackplus
     git remote set-url origin https://github.com/qatrackplus/qatrackplus.git
     git fetch origin
-    git checkout v3.1.1.1
+    git checkout v3.1.1.2
 
 
 Setting up our Python environment (including virtualenv)

docs/install/win_upgrade_from_3.rst

@@ -0,0 +1,112 @@
+.. _win_upgrading_31:
+
+Upgrading an existing Windows v3.X.Y installation to v3.1.1.2
+=============================================================
+
+This guide will walk you through upgrading your existing v3.X.Y installation to
+v3.1.1.2.  If you currently have a 0.3.x version of QATrack+, you first need to
+follow the :ref:`instructions to upgrade to 3.1 <win_upgrading_030_to_31>`,
+before carrying out these instructions.
+
+
+.. contents::
+    :local:
+    :depth: 2
+
+
+Take a snapshot
+~~~~~~~~~~~~~~~
+
+If your QATrack+ server exists on a virtual machine, now would be a great time
+to take a snapshot of your VM in case you need to restore it later!  Consult
+with your IT department on how to do this.
+
+
+Backing up your database
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+It is important you back up your database before attempting to
+upgrade.  In order to generate a backup open SQL Server Management Studio
+(SSMS), right click on your database then select `Tasks -> Back Up..`
+
+.. figure:: images/win/backup_menu.png
+    :alt: Backup Menu Item
+
+    Backup Menu Item
+
+Select `Copy-only backup` and make sure the `Backup component` is set to
+`Database`. Take note of where the backup is being stored and then click `OK`:
+
+
+.. figure:: images/win/backup_dialog.png
+    :alt: Backup Dialog
+
+    Backup Dialog
+
+
+Checking out version 3.1.1.2
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+First we must check out the code for version 3.1.1.2 in a PowerShell window:
+
+.. code-block:: console
+
+    cd C:\deploy\qatrackplus
+    git fetch origin
+    git checkout v3.1.1.2
+
+
+Updating our Python environment
+-------------------------------
+
+Activate your virtual environment:
+
+.. code-block:: bash
+
+    
+    cd C:\deploy
+    .\venvs\qatrack31\Scripts\Activate.ps1
+
+Your command prompt should now be prefixed with `(qatrack31)`.
+
+It's also a good idea to upgrade `pip` the Python package installer:
+
+.. code-block:: bash
+
+    pip install --upgrade pip
+
+We will now install all the libraries required for QATrack+ (be patient, this
+can take a few minutes!):
+
+.. code-block:: bash
+
+    cd C:\deploy\qatrackplus
+    pip install -r requirements\win.txt
+
+
+Performing the migration
+------------------------
+
+We can now migrate the tables in our database:
+
+.. code-block:: console
+
+    python manage.py migrate
+
+and then we need to update all our static media files:
+
+.. code-block:: bash
+
+    python manage.py collectstatic
+
+
+Restart QATrack+
+----------------
+
+Finally we need to restart QATrack+
+
+.. code-block:: bash
+
+    python manage.py QATrack31CherryPyService.py restart
+    Stop-ScheduledTask -TaskName "QATrack+ Django Q Cluster"
+    Start-ScheduledTask -TaskName "QATrack+ Django Q Cluster"

docs/release_notes.rst

@@ -1,6 +1,11 @@
 Release Notes
 =============
 
+.. _release_notes_311:
+
+QATrack+ v3.1.1.2 Release Notes
+-------------------------------
+* Fixed issue with Chromes font rendering in PDF reports
 
 QATrack+ v3.1.1.1 Release Notes
 -------------------------------
@@ -10,9 +15,6 @@ QATrack+ v3.1.1.1 Release Notes
 QATrack+ v3.1.1 Release Notes
 -----------------------------
 
-.. _release_notes_311:
-
-
 This is a follow up release to address a few issues that were found in v3.1.0. The following
 issues have been addressed: