Merge pull request #547 from MetRonnie/cherry-pick

Cherry pick from master onto 8.0.x

Author: oliver-sanders

README.md

@@ -84,7 +84,20 @@ We use a few custom Sphinx extensions, for details see
 
 ### Installation
 
-Note: you may need to install `graphviz` first (e.g. `conda install graphviz`).
+### Non Python Dependencies
+
+There are two non-Python dependencies which must be installed:
+
+* `graphviz`
+* `enchant`
+
+E.G. with Conda/Mamba:
+
+```console
+$ mamba install -c conda-forge graphviz enchant
+```
+
+### Checkout & Install
 
 ```console
 $ git clone [email protected]:cylc/cylc-doc.git cylc-doc

src/tutorial/furthertopics/retries.rst

@@ -116,7 +116,7 @@ Re-install and run the workflow::
    cylc play retries-tutorial
 
 What you should see is Cylc retrying the ``roll_doubles`` task. Hopefully,
-it will succeed (there is only about a about a 1 in 3 chance of every task
+it will succeed (there is only about a 1 in 3 chance of every task
 failing) and the workflow will continue.
 
 

src/tutorial/scheduling/datetime-cycling.rst

@@ -151,33 +151,27 @@ Recurrence Formats
    As with integer cycling, recurrences start at the :term:`initial cycle
    point` by default. We can override this in two ways:
 
-By giving an arbitrary start cycle point (``datetime/recurrence``):
+.. rubric::
+   By giving an arbitrary start cycle point (``datetime/recurrence``):
 
-.. csv-table::
-   :header: Example, Description
-   :align: left
-   :widths: 30, 70
-
-   ``2000/P4Y``, "Every fourth year, starting with the year 2000"
-   ``2000-01-01T00/T00``, "Every day at midnight, starting on the 1st of January 2000"
-   ``2000-01-01T12/T00``, "Every day at midnight, starting on the first midnight
-   after the 1st of January at 12:00 (i.e. ``2000-01-02T00``)."
+``2000/P4Y``
+   Every fourth year, starting with the year 2000.
+``2000-01-01T00/P1D``
+   Every day at midnight, starting on the 1st of January 2000.
 
 .. nextslide::
 
 .. _tutorial-cylc-datetime-offset-icp:
 
-By offset, relative to the initial cycle point (``offset/recurrence``).
-The offset must be an ISO8601 duration preceded by a plus character:
+.. rubric::
+   By offset, relative to the initial cycle point (``offset/recurrence``).
 
-.. csv-table::
-   :header: Example, Description
-   :align: left
-   :widths: 30, 70
+The offset must be an ISO8601 duration preceded by a plus character:
 
-   ``+P1Y/P1Y``, every year starting one year after the initial cycle point.
-   ``+PT1H/T00``, "every day starting on the first midnight after the point one
-   hour after the initial cycle point."
+``+PT1H/PT1H``
+   Every hour starting one hour after the initial cycle point.
+``+P1Y/P1Y``
+   Every year starting one year after the initial cycle point.
 
 Durations and the Initial Cycle Point
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

src/user-guide/sharing-access-to-workflows.rst

@@ -180,7 +180,7 @@ another person, and that cannot be prevented by technical means. However, a
 workflow owner cannot unilaterally gain access to any other user's account or
 workflows by configuring their own UI Server.
 
-``c.CylcUIServer.site-authorization``, which is loaded from
+``c.CylcUIServer.site_authorization``, which is loaded from
 ``/etc/cylc/uiserver/jupyter_config.py``, or, alternatively, the environment variable
 ``CYLC_SITE_CONF_PATH``, contains these site default and limit settings for
 users. This configuration should be entered as a Python dictionary.
@@ -193,7 +193,7 @@ Sites set both limits and defaults for users.
 - ``limit`` determines the maximum access users can grant to their workflows.
 
 - ``default`` sets a default access level, which applies if the user does
-  not appear in the user-authorization configuration (via explicit user name or group).
+  not appear in the user_authorization configuration (via explicit user name or group).
 
 Missing Configurations in Site Authorization
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

src/user-guide/writing-workflows/scheduler.rst

@@ -230,3 +230,20 @@ Example:
    .. cylc-scope::
 
 For more information see: :cylc:conf:`global.cylc[scheduler][run hosts]ranking`.
+
+Platform Configuration
+^^^^^^^^^^^^^^^^^^^^^^
+
+From the perspective of a running :term:`scheduler` ``localhost`` is the
+scheduler host.
+
+The ``localhost`` platform is configured by
+:cylc:conf:`global.cylc[platforms][localhost]`.
+
+It configures:
+
+* Jobs that run on the ``localhost`` platform, i.e. any jobs which have
+  :cylc:conf:`[runtime][<namespace>]platform=localhost` or which don't have a
+  platform configured.
+* Connections to the scheduler hosts (e.g. the
+  :cylc:conf:`ssh command <global.cylc[platforms][<platform name>]ssh command>`).