RUN-4060: Document Single-Screen Inline Runner Editing Feature #1754
Conversation
| ### When Regenerate is Available | ||
|
|
||
| The **Regenerate Credentials** button visibility depends on Runner type and replica configuration: | ||
|
|
||
| **View Mode Requirement:** | ||
|
|
||
| - The **Regenerate Credentials** button is only visible in view mode (not shown during edit mode to maintain focus on basic information editing) | ||
|
|
||
| **When Replicas Feature is Enabled:** | ||
|
|
||
| - **Ephemeral Runners**: Can regenerate credentials (designed for dynamic environments) | ||
| - **Manual Runners**: Cannot regenerate credentials (use "Add Replica" workflow instead) | ||
|
|
||
| **When Replicas Feature is Disabled (Legacy Mode):** | ||
|
|
||
| - All Runner types can regenerate credentials for backward compatibility | ||
|
|
There was a problem hiding this comment.
The heading "When Regenerate is Available" introduces conditions but the formatting could be improved for clarity. Consider restructuring this section to use a clearer heading hierarchy. The sub-sections "View Mode Requirement", "When Replicas Feature is Enabled", and "When Replicas Feature is Disabled (Legacy Mode)" appear to be at the same level but are formatted with bold text instead of using proper heading levels (####). This creates inconsistent documentation structure.
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
| **Note**: The **Node Dispatch** tab settings are managed and saved independently from the basic Runner information. To edit them, view a Runner (not in edit mode), open the **Node Dispatch** tab, adjust the settings, and use the tab's save action to persist those changes without affecting the other Runner fields. | ||
|
|
There was a problem hiding this comment.
The Note section contains an overly long sentence that is difficult to parse. Consider breaking this into multiple sentences or a bulleted list to improve readability. The sentence structure "To edit them, view a Runner (not in edit mode), open the Node Dispatch tab, adjust the settings, and use the tab's save action to persist those changes without affecting the other Runner fields" could be simplified with clearer step-by-step formatting or broken into shorter, more digestible sentences.
| **Note**: The **Node Dispatch** tab settings are managed and saved independently from the basic Runner information. To edit them, view a Runner (not in edit mode), open the **Node Dispatch** tab, adjust the settings, and use the tab's save action to persist those changes without affecting the other Runner fields. | |
| **Note**: The **Node Dispatch** tab settings are managed and saved independently from the basic Runner information. | |
| To edit these settings: | |
| 1. View the Runner detail page in **View Mode** (not Edit Mode) | |
| 2. Open the **Node Dispatch** tab | |
| 3. Adjust the settings as needed | |
| 4. Use the **Node Dispatch** tab's save action to persist those changes without affecting the other Runner fields |
fdevans
changed the base branch from
4.0.x
to
update-pr-feed-rba-5.19-RBA-20260107-18ac2eb-9f53a6c
fdevans
merged commit 9b6ea3b
into
update-pr-feed-rba-5.19-RBA-20260107-18ac2eb-9f53a6c
No description provided.