added a remove-task intervention to the user guid

cylc · Jan 7, 2025 · ae92428 · ae92428
1 parent 7fb4cad
commit ae92428
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/src/user-guide/interventions/index.rst b/src/user-guide/interventions/index.rst
@@ -488,3 +488,38 @@ Hold The Workflow And Trigger Tasks One By One
    Task Hold
       When a task is :term:`held <hold>`, then it will not submit (if ready to
       submit) until released.
+
+
+Remove Tasks
+------------
+
+:Example:
+   I triggered tasks I did not mean to. They may have run-on. I want to undo
+   this.
+
+:Solution:
+   Use ``cylc remove`` to remove unwanted tasks.
+
+.. tab-set::
+
+   .. tab-item:: GUI
+      :sync: gui
+
+      .. image:: remove.gif
+         :width: 75%
+
+      .. warning::
+
+         Internal implemenation details mean that the task icon will not be
+         removed.
+
+         .. the implementation detail in question is that remove removes
+         .. flows from tasks.
+
+
+   .. tab-item:: CLI
+      :sync: cli
+
+      .. code-block:: console
+
+         cylc remove <workflow>//<cycle>/<id>
diff --git a/src/user-guide/interventions/remove.gif b/src/user-guide/interventions/remove.gif