From d6a93a3b01416e5741f41d5d3255c5bde33d437c Mon Sep 17 00:00:00 2001
From: James Bruten <109733895+james-bruten-mo@users.noreply.github.com>
Date: Wed, 17 Apr 2024 13:32:37 +0100
Subject: [PATCH] Nightly retrigger (#159)

---
 source/Reviewers/nightlytesting.rst | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/source/Reviewers/nightlytesting.rst b/source/Reviewers/nightlytesting.rst
index 47a735eb..4719c9a3 100644
--- a/source/Reviewers/nightlytesting.rst
+++ b/source/Reviewers/nightlytesting.rst
@@ -51,12 +51,28 @@ To update and install at meto:
 
 .. code-block:: bash
 
-    python3 generate_test_suite_cron.py -c ~/nightly_testing_configs.yaml --install
+    python3 generate_test_suite_cron.py -c ~/Crontabs/nightly_testing_configs.yaml --install
 
 Retriggering Nightlies
 ----------------------
 
-To retrigger nightlies open a cylc8 gui by:
+TLDR Instructions
+^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+    #  As the testing user
+    rs8
+    # Wait for retrigger script to run - answer questions as required
+    cylc_url
+    # Select the 2nd url that appears
+
+Full Explanation
+^^^^^^^^^^^^^^^^
+
+To retrigger the nightlies a script is available at ``~frum/SimSys_Scripts/nightly_testing/retrigger_nightlies.py``. To run this use the alias ``rs8`` which will load the required modules and set the cylc version to 8. The script will detect any suites from the previous night with failed tasks and ask whether to retrigger them. It will restart requested suites, sleep, and then individually retrigger any failed tasks. Running ``rs8 PATTERN`` will only launch suites which match that pattern (no wildcard matching is currently setup), eg. ``rs8 lfric_apps`` will restart suites with "lfric_apps" in their name.
+
+To interact with the nightlies open a cylc8 gui by:
 
 .. code-block:: bash
 
@@ -65,7 +81,7 @@ To retrigger nightlies open a cylc8 gui by:
 
 or the meto user has an alias defined as ``cylc_url``. Copy the 2nd url that appears into your browser.
 
-Select the suite on the left and then click the play triangle at the top. This can also be done on the command line by:
+Suites can also be triggered without using the script. In the gui, select the suite on the left and then click the play triangle at the top. This can also be done on the command line by:
 
 .. code-block:: bash