Skip to content

Commit 21b6c8e

Browse files
[cuegui] Add descriptive labels to Monitor Jobs action buttons (#1846)
[cuegui] Add descriptive labels to Monitor Jobs action buttons - Add clear text labels to all action buttons for better discoverability - Update tooltips to explain each action's purpose - Buttons now display: "Eat Dead Frames", "Retry Dead Frames", "Kill Jobs", "Pause Jobs", "Unpause Jobs" - Improves UI accessibility and reduces user confusion about button functions - [docs] Update documentation for Monitor Jobs descriptive button labels - Update cuetopia-monitoring-guide.md with new button labels and descriptions - Update CueGUI-app.md reference to reflect new toolbar button labels - Document button functionality: "Eat Dead Frames", "Retry Dead Frames", "Kill Jobs", "Pause Jobs", "Unpause Jobs" - Clarify button tooltips and their purposes in the documentation - Update CueGUI images in the documentation **Link the Issue(s) this Pull Request is related to.** - #1845
1 parent 13c67f0 commit 21b6c8e

13 files changed

+34
-31
lines changed

cuegui/cuegui/plugins/MonitorJobsPlugin.py

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -294,38 +294,35 @@ def handleUnmonitorSelection(index):
294294
unmonitorCombo.currentIndexChanged.connect(handleUnmonitorSelection)
295295
layout.addWidget(unmonitorCombo)
296296

297-
eatSelectedButton = QtWidgets.QPushButton(QtGui.QIcon(":eat.png"), "")
298-
eatSelectedButton.setToolTip("Eats all dead frames for selected jobs")
297+
eatSelectedButton = QtWidgets.QPushButton(QtGui.QIcon(":eat.png"), "Eat Dead Frames")
298+
eatSelectedButton.setToolTip(
299+
"Eats all dead frames for selected jobs to free scheduling resources")
299300
eatSelectedButton.setFocusPolicy(QtCore.Qt.NoFocus)
300-
eatSelectedButton.setFlat(True)
301301
layout.addWidget(eatSelectedButton)
302-
eatSelectedButton.clicked.connect(self.jobMonitor.actionEatSelectedItems) # pylint: disable=no-member
302+
eatSelectedButton.clicked.connect(
303+
self.jobMonitor.actionEatSelectedItems) # pylint: disable=no-member
303304

304-
retryButton = QtWidgets.QPushButton(QtGui.QIcon(":retry.png"), "")
305+
retryButton = QtWidgets.QPushButton(QtGui.QIcon(":retry.png"), "Retry Dead Frames")
305306
retryButton.setToolTip("Retries all dead frames for selected jobs")
306307
retryButton.setFocusPolicy(QtCore.Qt.NoFocus)
307-
retryButton.setFlat(True)
308308
layout.addWidget(retryButton)
309309
retryButton.clicked.connect(self.jobMonitor.actionRetrySelectedItems) # pylint: disable=no-member
310310

311-
killButton = QtWidgets.QPushButton(QtGui.QIcon(":kill.png"), "")
312-
killButton.setToolTip("Kill selected jobs")
311+
killButton = QtWidgets.QPushButton(QtGui.QIcon(":kill.png"), "Kill Jobs")
312+
killButton.setToolTip("Kill selected jobs and their running frames")
313313
killButton.setFocusPolicy(QtCore.Qt.NoFocus)
314-
killButton.setFlat(True)
315314
layout.addWidget(killButton)
316315
killButton.clicked.connect(self.jobMonitor.actionKillSelectedItems) # pylint: disable=no-member
317316

318-
pauseButton = QtWidgets.QPushButton(QtGui.QIcon(":pause.png"), "")
319-
pauseButton.setToolTip("Pause selected jobs")
317+
pauseButton = QtWidgets.QPushButton(QtGui.QIcon(":pause.png"), "Pause Jobs")
318+
pauseButton.setToolTip("Pause selected job")
320319
pauseButton.setFocusPolicy(QtCore.Qt.NoFocus)
321-
pauseButton.setFlat(True)
322320
layout.addWidget(pauseButton)
323321
pauseButton.clicked.connect(self.jobMonitor.actionPauseSelectedItems) # pylint: disable=no-member
324322

325-
unpauseButton = QtWidgets.QPushButton(QtGui.QIcon(":unpause.png"), "")
323+
unpauseButton = QtWidgets.QPushButton(QtGui.QIcon(":unpause.png"), "Unpause Jobs")
326324
unpauseButton.setToolTip("Unpause selected jobs")
327325
unpauseButton.setFocusPolicy(QtCore.Qt.NoFocus)
328-
unpauseButton.setFlat(True)
329326
layout.addWidget(unpauseButton)
330327
unpauseButton.clicked.connect(self.jobMonitor.actionResumeSelectedItems) # pylint: disable=no-member
331328

docs/_docs/reference/CueGUI-app.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,30 +62,36 @@ CueGUI provides convenient copy buttons to quickly copy job, layer, and frame na
6262

6363
To copy a job name to the clipboard, right-click on a job in the *Monitor Jobs* view and select **Copy Job Name**. The exact job name will be copied to your clipboard.
6464

65-
![Copy Job Name context menu](/assets/images/cuegui/cuegui_copy_job_name.png)
65+
![Copy Job Name context menu](/assets/images/cuegui/cuetopia/cuegui_copy_job_name.png)
6666

6767
### Copying layer names
6868

6969
To copy a layer name, right-click on a layer in the job details view and select **Copy Layer Name**. This copies the layer name to your clipboard.
7070

71-
![Copy Layer Name context menu](/assets/images/cuegui/cuegui_copy_layer_name.png)
71+
![Copy Layer Name context menu](/assets/images/cuegui/cuetopia/cuegui_copy_layer_name.png)
7272

7373
### Copying frame names
7474

7575
To copy a frame name, right-click on a frame in the frame list and select **Copy Frame Name**. The frame name will be copied to your clipboard.
7676

77-
![Copy Frame Name context menu](/assets/images/cuegui/cuegui_copy_frame_name.png)
77+
![Copy Frame Name context menu](/assets/images/cuegui/cuetopia/cuegui_copy_frame_name.png)
7878

7979
All copy buttons use the same icon as the "Copy Log Path" feature for visual consistency. When multiple items are selected, all selected names will be copied to the clipboard separated by spaces.
8080

81-
## Managing frames
81+
## Managing frames and jobs
8282

83-
To manage frames, select one of the following:
83+
The Monitor Jobs toolbar provides action buttons for managing jobs and frames:
8484

85-
* **Retry** - Retrying a frame stops rendering and retries the frame on
86-
another proc.
87-
* **Eat** - Eating a frame stops rendering and doesn't try to continue
88-
processing the frame.
85+
* **Eat Dead Frames** - Eats all dead frames for selected jobs to free scheduling resources. Eating a frame stops rendering and marks it as complete without retrying.
86+
* **Retry Dead Frames** - Retries all dead frames for selected jobs. Retrying requeues failed frames to run again.
87+
* **Kill Jobs** - Kill selected jobs and their running frames. Stops all processing for the selected jobs.
88+
* **Pause Jobs** - Pause selected job. No new frames will start on paused jobs.
89+
* **Unpause Jobs** - Unpause selected jobs. Resumes processing of paused jobs.
90+
91+
Individual frame management options are also available through right-click context menus:
92+
93+
* **Retry** - Retrying a frame stops rendering and retries the frame on another proc.
94+
* **Eat** - Eating a frame stops rendering and doesn't try to continue processing the frame.
8995
* **Kill** - Killing a frame stops rendering and books to another proc.
9096

9197
## Rendering and staggering frames

docs/_docs/user-guides/cuetopia-monitoring-guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ The toolbar contains the following controls from left to right:
6969
- **Selected Jobs**: Removes selected jobs
7070

7171
8. **Action Buttons** (from left to right):
72-
- **Eat** (pac-man icon): Eats all dead frames in selected jobs
73-
- **Retry** (circular arrow): Retries all dead frames in selected jobs
74-
- **Kill** (X icon): Kills selected jobs
75-
- **Pause** (pause icon): Pauses selected jobs
76-
- **Unpause** (play icon): Resumes selected paused jobs
72+
- **Eat Dead Frames** (pac-man icon): Eats all dead frames for selected jobs to free scheduling resources
73+
- **Retry Dead Frames** (circular arrow): Retries all dead frames for selected jobs
74+
- **Kill Jobs** (X icon): Kill selected jobs and their running frames
75+
- **Pause Jobs** (pause icon): Pause selected job
76+
- **Unpause Jobs** (play icon): Unpause selected jobs
7777

7878
### Job Table Columns
7979

@@ -141,7 +141,7 @@ Right-clicking on a job provides these actions:
141141

142142
The Monitor Job Details plugin provides detailed information about a selected job's layers and frames. It can be opened manually from the menu or appears automatically when you double-click a job in the Monitor Jobs view.
143143

144-
![Job Details Interface](/assets/images/cuegui/cuetopia_monitor_jobs_details.png)
144+
![Job Details Interface](/assets/images/cuegui/cuetopia/cuetopia_monitor_jobs_details.png)
145145

146146
### Layout Structure
147147

@@ -232,7 +232,7 @@ Frames are color-coded by status:
232232

233233
The Job Graph plugin provides a visual node-based representation of job layers and their dependencies.
234234

235-
![Job Graph Interface](/assets/images/cuegui/cuetopia_job_graph.png)
235+
![Job Graph Interface](/assets/images/cuegui/cuetopia/cuetopia_job_graph.png)
236236

237237
### Graph Features
238238

docs/_docs/user-guides/monitoring-jobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ The OS filter allows you to filter hosts based on their operating system:
157157
4. The host list updates to show only hosts matching the selected OS values
158158
5. Use the **Clear** option to remove all OS filters
159159

160-
![Monitor Hosts with OS Filter](/assets/images/cuegui/cuecommander_monitor_os_filter.png)
160+
![Monitor Hosts with OS Filter](/assets/images/cuegui/cuecommander/cuecommander_monitor_os_filter.png)
161161

162162
The OS filter list dynamically updates based on the operating systems detected in your host environment. When you first open CueCommander, the filter displays "Not Loaded" to indicate that host data hasn't been retrieved yet. Once hosts are loaded, the filter automatically populates with the actual OS values found in your system.
163163

253 KB
Loading
-96.8 KB
Loading

0 commit comments

Comments
 (0)