QUA-1756: Add Operations Runs documentation and document Auto-Resolve#1136
Open
RafaelOsiro wants to merge 5 commits into
Open
QUA-1756: Add Operations Runs documentation and document Auto-Resolve#1136RafaelOsiro wants to merge 5 commits into
RafaelOsiro wants to merge 5 commits into
Conversation
RafaelOsiro
requested review from
Hitsu-360,
ets,
gasscoelho,
josecsotomorales,
pelegolas9 and
shindiogawa
Adds the Operations → Runs documentation: Getting Started, Deep Dive (Introduction, Lifecycle, Available Actions, Permissions), By Operation Type (Scan in 5 states), API, and FAQ. Migrates Scan run-state screenshots to the new layout, refreshes the Operations overview, aligns sibling operation H1 icons, removes the legacy interpret-results page, and adds the qua-icon-auto-resolved CSS utility for the composite Auto-Resolved indicator. Also reorders the Scan submenu to Troubleshooting → API → FAQ.
RafaelOsiro
changed the title
ets
reviewed
Jun 18, 2026
ets
left a comment
ets
left a comment
Contributor
There was a problem hiding this comment.
Reviewed for obvious errors. The restructure is solid — nav targets, redirect map, image paths, include-markdown directives, and admonitions/code fences all check out. One concrete issue worth fixing before merge:
Two broken internal links to the deleted scan/scan.md page (with a dead anchor):
This PR deletes docs/operations/scan/scan.md and moves the Unloadable Container Error section to docs/operations/scan/troubleshooting.md (#unloadable-container-error). Two files still point at the old path + anchor:
docs/operations/profile/profile.md:753—[Unloadable Container Error](../scan/scan.md#unloadable-container-error)docs/operations/sync/sync.md:43—[Unloadable Container Error](../scan/scan.md#unloadable-container-error)
The mkdocs.yml redirect (operations/scan/scan.md → getting-started.md) redirects the page but drops the #unloadable-container-error anchor, which doesn't exist on getting-started.md — so these land on the wrong page with a dead anchor. The correct target is ../scan/troubleshooting.md#unloadable-container-error (which this PR's own select-tables.md:29 already uses correctly).
Everything else looks good.
Generated by Claude Code
…shooting.md The Profile and Sync pages still linked to the deleted scan/scan.md page with the #unloadable-container-error anchor. The mkdocs redirect on the parent page drops the anchor, so the old links landed on scan/getting-started/ with a dead anchor. Repoint at the actual home of the section: scan/troubleshooting.md#unloadable-container-error.
Contributor
Author
|
Addressed in
|
Contributor
Greptile SummaryThis PR adds the complete Operations → Runs documentation section (Getting Started, Deep Dive, five Scan run-state walkthroughs, API, and FAQ), refreshes the Operations overview hub with FE-aligned icons, and introduces the
Confidence Score: 4/5Safe to merge after correcting the Running badge color from "orange" to blue/tertiary in running.md. The Running badge is documented as "orange" across four places in running.md, but the frontend badge component styles it as blue/tertiary (#5B86AA). This directly contradicts the PR's FE-validated-colors goal and would cause confusion for readers trying to identify the Running state in the UI. Everything else in the new documentation section — icon assignments, timeline colors, permission matrices, nav order, and API reference — is accurate and consistent. docs/operations/runs/by-types/scan/running.md — four occurrences of "orange" for the Running badge need to be corrected to blue/tertiary. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
Q([Queued\n🔵 blue/info]) -->|worker picks up| R([Running\n🔵 blue/tertiary])
R -->|completes cleanly| S([Success\n🟢 positive])
R -->|completes with log entries| SW([Success + Warning indicator\n🟢 positive + ⚠️ warning])
R -->|fatal error| F([Failure\n🔴 negative])
R -->|user/system stop| A([Aborted\n⚠️ warning])
F -->|Resume – profile/scan/promote| R
A -->|Resume – profile/scan/promote| R
S -->|Rerun| Q
SW -->|Rerun| Q
F -->|Rerun| Q
A -->|Rerun| Q
S -->|Delete| DEL([Record removed])
SW -->|Delete| DEL
F -->|Delete| DEL
A -->|Delete| DEL
style Q fill:#2163D0,color:#fff
style R fill:#5B86AA,color:#fff
style S fill:#21BA45,color:#fff
style SW fill:#21BA45,color:#fff
style F fill:#E91E63,color:#fff
style A fill:#ffbb33,color:#000
style DEL fill:#9e9e9e,color:#fff
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
Q([Queued\n🔵 blue/info]) -->|worker picks up| R([Running\n🔵 blue/tertiary])
R -->|completes cleanly| S([Success\n🟢 positive])
R -->|completes with log entries| SW([Success + Warning indicator\n🟢 positive + ⚠️ warning])
R -->|fatal error| F([Failure\n🔴 negative])
R -->|user/system stop| A([Aborted\n⚠️ warning])
F -->|Resume – profile/scan/promote| R
A -->|Resume – profile/scan/promote| R
S -->|Rerun| Q
SW -->|Rerun| Q
F -->|Rerun| Q
A -->|Rerun| Q
S -->|Delete| DEL([Record removed])
SW -->|Delete| DEL
F -->|Delete| DEL
A -->|Delete| DEL
style Q fill:#2163D0,color:#fff
style R fill:#5B86AA,color:#fff
style S fill:#21BA45,color:#fff
style SW fill:#21BA45,color:#fff
style F fill:#E91E63,color:#fff
style A fill:#ffbb33,color:#000
style DEL fill:#9e9e9e,color:#fff
Reviews (2): Last reviewed commit: "docs(runs): align Aborted Timeline color..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
… Resume on Scan Failure - Timeline icon legend on success/success-with-warning/failure/aborted/ running pages now colors the Operation Aborted terminal marker with --q-warning (amber) to match the 'States at a glance' table on the Runs Introduction page. Previously it was --q-negative (red), which conflicted with the Aborted state badge color throughout the section. - Scan Failure: the row description and a follow-up note now mention that a Resume button appears alongside Rerun/Delete on recoverable failures. The Settings table keeps the numbered rows aligned with the screenshot annotations (Results/Rerun/Delete), with a callout above pointing to the Available Actions reference for the full rules.
Contributor
Author
|
Addressed in
All three threads resolved. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Adds the new Operations → Runs documentation section and rounds out the QUA-1756 Auto-Resolve coverage that started in the Scan Operation rewrite. Documents Run lifecycle, available actions, permissions, per-state walkthroughs for Scan Runs, and refreshes the Operations overview hub.
Key Changes
mdi-check-circle, Failure →mdi-close-circle, Aborted →mdi-alert-circlewarning, Running/Queued →mdi-loading)..qua-icon-auto-resolvedCSS utility renders the filled triangle + check overlay used on Scan Runs.scan/how-tos/interpret-results.md(replaced by per-state pages underruns/by-types/scan/); ran the Scan run-state screenshots through the migration todocs/assets/operations/runs/by-types/scan/.Pages to Test
Operations Overview
Runs — Getting Started + Deep Dive
var(--q-orange)Abort icon; Delete description scoped to the Run record.Runs — By Operation Type (Scan)
[INFO]abort actor line.Runs — API + FAQ
catalog (Sync operation)clarification on the operation_type row; no em-dash in the Scan API cross-reference.Cross-cutting
qua-icon-auto-resolvedcomposite (filled triangle + white/dark check overlay) renders inline at body-text size and inverts contrast correctly when switching themes.