cylc vip (#533)

* add references to cylc vip

* Update src/user-guide/compound-commands.rst

Co-authored-by: Melanie Hall <[email protected]>

* Update src/7-to-8/major-changes/cli.rst

Co-authored-by: Ronnie Dutta <[email protected]>

* Update src/7-to-8/cheat-sheet.rst

Co-authored-by: Ronnie Dutta <[email protected]>

* Update src/user-guide/compound-commands.rst

Co-authored-by: Melanie Hall <[email protected]>
Co-authored-by: Ronnie Dutta <[email protected]>

Author: 3 people

src/7-to-8/cheat-sheet.rst

@@ -59,6 +59,10 @@ Install a workflow from source and run it:
          # run the installed workflow
          cylc play <name>
 
+         # alternatively:
+         # validate, install & play
+         cylc vip <name>
+
 
 Reloading
 ---------
@@ -79,7 +83,7 @@ To update a running workflow with changes from the source directory:
      - ::
 
          # re-install from source
-         # and do ``cylc reload`` 
+         # and do ``cylc reload``
          rose suite-run --reload
      - ::
 

src/7-to-8/major-changes/cli.rst

@@ -113,6 +113,13 @@ GUI. Consequently the following commands have also been removed:
 The ``cylc gui`` command remains, it launches a standalone version of the
 web GUI (providing the `Cylc UI Server`_ is installed).
 
+.. seealso::
+
+   :ref:`CompoundCommands` - For your convenience we have
+    provided commands which represent common working practices. For
+    example ``cylc vip`` (Validate-Install-Play) which runs
+    ``cylc validate``, ``cylc install`` and ``cylc play``.
+
 
 Cylc 8 Standardised IDs
 -----------------------

src/user-guide/compound-commands.rst

@@ -0,0 +1,28 @@
+.. _CompoundCommands:
+
+Compound Commands
+=================
+
+Cylc provides compound commands which carry out more than one
+workflow action. For example Cylc provides a command to validate,
+install and play a workflow.
+
+Compound commands make common ways of working easier.
+
+.. note::
+
+   Use ``cylc command --help`` to get help for each compound command,
+   including a full list of available options.
+
+
+``cylc vip`` (Validate, Install and Play)
+-----------------------------------------
+
+``cylc vip /home/me/cylc-src/my-workflow`` is the same as running:
+
+.. code-block:: bash
+
+   $ cylc validate /home/me/cylc-src/my-workflow
+   $ cylc install /home/me/cylc-src/my-workflow
+   INSTALLED my-workflow/run1 from /home/me/cylc-src/my-workflow
+   $ cylc play my-workflow

src/user-guide/index.rst

@@ -12,3 +12,4 @@ User Guide
    task-implementation/index
    removing-workflows
    sharing-access-to-workflows
+   compound-commands