Skip to content

Commit 68a4cd1

Browse files
changes: document cylc-ui#1755 (#721)
* Closes #719
1 parent 0de1bb7 commit 68a4cd1

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

src/reference/changes.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ you would need to perform with Cylc 8.2 and 8.3 side-by-side.
5151

5252
.. list-table::
5353
:class: grid-table
54+
:widths: 50 50
5455

5556
* - **Cylc 8.2** (set-outputs)
5657
- **Cylc 8.3** (set)
@@ -88,6 +89,37 @@ workflows which would previously have caused it to time out.
8889
.. image:: changes/tui-1.gif
8990
:width: 100%
9091

92+
93+
N-Window selector in the GUI
94+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
95+
96+
The :term:`n-window` determines how much of a workflow is visible in the GUI / Tui.
97+
98+
The ``n=0`` window contains only the active tasks
99+
(i.e. queued, preparing, submitted or running tasks).
100+
101+
The ``n=1`` window, also contains tasks one "edge" out from active tasks
102+
(i.e. the tasks immediately upstream or downstream of active tasks).
103+
104+
The ``n=2`` window, also contains tasks two "edges" out from active tasks,
105+
and so on.
106+
107+
It is now possible to change the window extent in the GUI via a button in the
108+
toolbar allowing you to see tasks further back in the workflow's history.
109+
110+
.. image:: changes/gui-n-window-selector.gif
111+
:width: 100%
112+
113+
.. note::
114+
115+
This is currently a per-workflow setting so changing the n-window in one
116+
browser tab will also change it in other browser tabs and Tui sessions.
117+
118+
.. warning::
119+
120+
Using high n-window values with complex workflows may have performance
121+
impacts.
122+
91123
----------
92124

93125
Cylc 8.2
2.53 MB
Loading

0 commit comments

Comments
 (0)