Merge pull request #705 from oliver-sanders/sync

MetRonnie · web-flow · commit 478356db3d91 · 2024-04-05T15:42:50.000+01:00
sync
diff --git a/src/reference/changes.rst b/src/reference/changes.rst
@@ -20,23 +20,29 @@ For more detail see the component changelogs:
 * `metomi-rose-changelog`_
 * `metomi-isodatetime-changelog`_
 
-
 ----------
 
-Cylc 8.3.0
-----------
+Cylc 8.2
+--------
 
 .. admonition:: Cylc Components
    :class: hint
 
-   TODO
+   :cylc-flow: `8.2 <https://github.com/cylc/cylc-flow/blob/master/CHANGES.md>`__
+   :cylc-uiserver: `1.4 <https://github.com/cylc/cylc-uiserver/blob/master/CHANGES.md>`__
+   :cylc-rose: `1.3 <https://github.com/cylc/cylc-rose/blob/master/CHANGES.md>`__
 
-..
-   Uncomment this before 8.3.0 release
 
-   :cylc-flow: `8.3 <https://github.com/cylc/cylc-flow/blob/8.3.x/CHANGES.md>`__
-   :cylc-uiserver: `1.4 <https://github.com/cylc/cylc-uiserver/blob/1.4.x/CHANGES.md>`__
-   :cylc-rose: `1.4 <https://github.com/cylc/cylc-rose/blob/1.4.x/CHANGES.md>`__
+UI now remembers workspace tab layout
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. versionadded:: cylc-uiserver 1.4.4
+
+The UI now remembers the layout of your workspace tabs when you navigate away
+from that workflow. Note that this only applies per browser session.
+
+.. image:: changes/ui-workspace-tabs.gif
+   :width: 100%
 
 Cylc ignores ``$PYTHONPATH``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -64,6 +70,8 @@ workflows which would previously have caused it to time out.
 Upgrade To The Latest Jupyter Releases
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. versionadded:: cylc-uiserver 1.4.0
+
 The Cylc UI Server has been updated to work with the latest releases of
 `Jupyter Server`_ and `Jupyter Hub`_.
 
@@ -72,32 +80,7 @@ will require some changes to work with these releases.
 
 See :ref:`cylc.uiserver.multi-user` for more details
 
-
-UI now remembers workspace tab layout
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The UI now remembers the layout of your workspace tabs when you navigate away
-from that workflow. Note that this only applies per browser session.
-
-.. image:: changes/ui-workspace-tabs.gif
-   :width: 100%
-
-
-----------
-
-Cylc 8.2.0
-----------
-
-.. admonition:: Cylc Components
-   :class: hint
-
-   :cylc-flow: `8.2 <https://github.com/cylc/cylc-flow/blob/master/CHANGES.md>`__
-   :cylc-uiserver: `1.3 <https://github.com/cylc/cylc-uiserver/blob/master/CHANGES.md>`__
-   :cylc-rose: `1.3 <https://github.com/cylc/cylc-rose/blob/master/CHANGES.md>`__
-
-
-Configure The Default View
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. versionadded:: cylc-uiserver 1.3.0
 
 You can now configure the view which is opened by default when you navigate to
 a new workflow in the GUI. Navigate to the settings page to select your chosen
@@ -113,6 +96,8 @@ configuring certain options on those views.
 Reload
 ^^^^^^
 
+.. versionadded:: cylc-flow 8.2.0
+
 When workflows are
 :ref:`reloaded <Reloading The Workflow Configuration At Runtime>`,
 (e.g. by ``cylc reload``), Cylc will now pause the workflow and wait for any
@@ -124,8 +109,8 @@ workflow status message which appears at the top of the GUI and Tui interfaces.
 
 ----------
 
-Cylc 8.1.0
-----------
+Cylc 8.1
+--------
 
 .. admonition:: Cylc Components
    :class: hint
@@ -140,9 +125,22 @@ Cylc 8.1.0
    **cannot** be restarted with Cylc 8.1 due to database changes.
 
 
+Analysis View
+^^^^^^^^^^^^^
+
+.. versionadded:: cylc-uiserver 1.2.2
+
+The web UI also has a new view for displaying task queue & run time statistics.
+
+.. image:: changes/analysis_view.gif
+   :width: 80%
+
+
 Graph View
 ^^^^^^^^^^
 
+.. versionadded:: cylc-uiserver 1.2.0
+
 The web UI now has a graph view which displays a visualisation of a workflow's graph:
 
 .. image:: changes/cylc-graph.gif
@@ -155,6 +153,8 @@ will be added in later releases.
 Log View
 ^^^^^^^^
 
+.. versionadded:: cylc-uiserver 1.2.0
+
 The web UI now has a log view which displays workflow and job log files:
 
 .. image:: changes/log-view-screenshot.png
@@ -163,9 +163,12 @@ The web UI now has a log view which displays workflow and job log files:
 Support for viewing more log files, syntax highlighting, searching and line
 numbers are planned for future releases.
 
+
 Edit Runtime
 ^^^^^^^^^^^^
 
+.. versionadded:: cylc-uiserver 1.2.0
+
 The web UI now has a command for editing the :cylc:conf:`[runtime]` section
 of a task or family.
 
@@ -174,19 +177,12 @@ of a task or family.
 
 Any changes made are :ref:`broadcast <cylc-broadcast>` to the running workflow.
 
-Analysis View
-^^^^^^^^^^^^^
-
-.. versionadded:: cylc-uiserver 1.2.2
-
-The web UI also has a new view for displaying task queue & run time statistics.
-
-.. image:: changes/analysis_view.gif
-   :width: 80%
 
 Combined Commands
 ^^^^^^^^^^^^^^^^^
 
+.. versionadded:: cylc-flow 8.1.0
+
 Two new commands have been added as short-cuts for common working patterns:
 
 ``cylc vip``
@@ -217,6 +213,8 @@ For more information see the command line help:
 Bash Completion
 ^^^^^^^^^^^^^^^
 
+.. versionadded:: cylc-flow 8.1.0
+
 Cylc now provides a high performance Bash completion script which saves you typing:
 
 * Cylc commands & options
@@ -232,8 +230,8 @@ Cylc now provides a high performance Bash completion script which saves you typi
 
 ----------
 
-Cylc 8.0.0
-----------
+Cylc 8.0
+--------
 
 .. admonition:: Cylc Components
    :class: hint
diff --git a/src/tutorial/runtime/runtime-configuration.rst b/src/tutorial/runtime/runtime-configuration.rst
@@ -378,14 +378,22 @@ Start, Stop, Restart
          cylc install
 
       Open a user interface (:ref:`tutorial.tui` or :ref:`tutorial.gui`) to view
-      your workflow.
+      your workflow. Run the workflow either from the UI or command line.
 
-      Run the workflow either by pressing the play button in the Cylc UI or by
-      running the command:
+      .. spoiler:: Hint hint
 
-      .. code-block:: bash
+         .. code-block:: bash
+
+            cylc tui runtime-tutorial
+            # or
+            cylc gui  # If you haven't already got an instance running.
 
-         cylc play runtime-tutorial
+         Run the workflow either by:
+
+         * GUI: selecting the runtime-tutorial workflow in the sidebar and
+           pressing the play button.
+         * Tui: pressing enter on the workflow and selecting "play".
+         * Command line: running ``cylc play runtime-tutorial``.
 
       If all goes well the workflow will startup and the tasks will run and
       succeed. Note that the tasks which do not have a ``[runtime]`` section
@@ -430,34 +438,40 @@ Start, Stop, Restart
       :term:`run directory`. Copy the code in the ``runtime`` file to the
       bottom of the :cylc:conf:`flow.cylc` file.
 
+      Now that all the tasks have runtime sections, remove
+      :cylc:conf:`[scheduler]allow implicit tasks`:
+
+      .. code-block:: diff
+
+          [scheduler]
+              UTC mode = True
+         -    allow implicit tasks = True  # TODO: remove at end of exercise
+
+      Removing this ensures that any tasks in the graph without a corresponding
+      runtime section will cause validation to fail (e.g. due to a typo).
+
       Check the :cylc:conf:`flow.cylc` file is valid by running the command:
 
       .. code-block:: bash
 
          cylc validate .
-         cylc install
 
-      .. TODO: Add advice on what to do if the command fails.
+      Now install a new run of the workflow:
 
-   #. **Run The Workflow.**
+      .. code-block:: bash
 
-      Open a user interface (:ref:`tutorial.tui` or :ref:`tutorial.gui`) to view
-      your workflow.
+         cylc install
 
-      .. spoiler:: Hint hint
+      .. TODO: Add advice on what to do if the command fails.
 
-         .. code-block:: bash
+   #. **Run The Workflow.**
 
-            cylc tui runtime-tutorial
-            # or
-            cylc gui  # If you haven't already got an instance running.
+      Open a user interface (:ref:`tutorial.tui` or :ref:`tutorial.gui`) and
+      run the workflow.
 
-         Run the workflow either by:
+      .. tip::
 
-         * Pressing the play button in the Cylc GUI. Then, ensuring that
-           "Cold Start" is selected within the dialogue window, pressing the
-           "Start" button.
-         * Running the command ``cylc play runtime-tutorial``.
+         Make sure you play the latest run that was newly installed.
 
    #. **View The Forecast Summary.**
 
diff --git a/src/user-guide/running-workflows/scheduler-log-files.rst b/src/user-guide/running-workflows/scheduler-log-files.rst
@@ -11,7 +11,7 @@ The information logged here includes:
 - Event timestamps, at the start of each line
 - Workflow server host, port and process ID
 - Workflow initial and final cycle points
-- Workflow start type (i.e. cold start, warn start, restart)
+- Workflow (re)start number (1 for the first play, 2 or more for restarts)
 - Task events (task started, succeeded, failed, etc.)
 - Workflow stalled warnings.
 - Client commands (e.g. ``cylc hold``)
