Skip to content

QUA-1806: Document scan-triggered status changes in anomaly history#1122

Open
RafaelOsiro wants to merge 2 commits into
mainfrom
qua-1806-anomaly-lifecycle-history-fixes
Open

QUA-1806: Document scan-triggered status changes in anomaly history#1122
RafaelOsiro wants to merge 2 commits into
mainfrom
qua-1806-anomaly-lifecycle-history-fixes

Conversation

@RafaelOsiro
Copy link
Copy Markdown
Contributor

@RafaelOsiro RafaelOsiro commented May 19, 2026

Warning

This PR depends on userguide#1121 getting merged first.

Overview

Documents the anomaly history entries emitted when a scan changes an anomaly's status through Auto Resolve Anomalies or Reactivate Recurring Anomalies, attributing them to Qualytics and (for Auto Resolve) linking back to the originating scan. Also mentions assignee changes in the History events list and applies light style polish to the Description note (em-dash removal plus trailing periods).

Key Changes

  • History scan attribution: new !!! note admonition under Anomaly Insights → History documenting Qualytics attribution and the scan link for Auto Resolve / Reactivate Recurring Anomalies status changes.
  • Recorded events list: adds assignee changes alongside status changes, description edits, and tag updates.
  • Style polish: two em-dashes removed (Description note and Unlinking a Ticket paragraph) and trailing periods added to the two bullets inside the Description note.

Pages to Test

Adds an admonition under Anomaly Insights → History explaining that
Auto Resolve Anomalies and Reactivate Recurring Anomalies status
changes are attributed to Qualytics, with Auto Resolve entries
linking back to the scan. Also mentions assignee changes in the
recorded events list and removes two em-dashes (Description note
and Unlinking a Ticket paragraph).
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label May 19, 2026
@RafaelOsiro RafaelOsiro self-assigned this May 19, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 19, 2026

Greptile Summary

This PR documents scan-triggered anomaly status changes in the History section of the Anomaly Insights page. It adds a note attributing Auto Resolve Anomalies and Reactivate Recurring Anomalies history entries to Qualytics (with a scan link for Auto Resolve), adds assignee changes to the recorded-events list, and replaces two em-dashes with period-separated sentences for consistency.

  • History section: new !!! note admonition explaining Qualytics attribution and the scan back-link for Auto Resolve entries.
  • Recorded events list: assignee changes added alongside status changes, description edits, and tag updates.
  • Em-dash cleanup: two em-dashes converted to separate sentences in the Description note and the Unlinking a Ticket paragraph.

Confidence Score: 4/5

Safe to merge — all changes are documentation only, with no code or configuration touched.

The change is purely additive documentation. The new admonition and updated events list are clear and internally consistent. A trailing period is missing on a changed bullet, and the adjacent unchanged bullet has the same gap — both are cosmetic and easy to fix.

docs/anomalies/details/insights.md — specifically the two bullets in the Description !!! note block that are missing trailing periods.

Important Files Changed

Filename Overview
docs/anomalies/details/insights.md Documentation-only update adding scan attribution note to History section, assignee changes to the recorded events list, and replacing two em-dashes with period-separated sentences. One minor missing period in a changed bullet point.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Scan Runs] --> B{Status Change Triggered?}
    B -- No --> C[No History Entry]
    B -- Yes --> D{Source}
    D -- Auto Resolve Anomalies --> E[History Entry: Attributed to Qualytics + Link to originating scan]
    D -- Reactivate Recurring Anomalies --> F[History Entry: Attributed to Qualytics, No scan link]
    D -- Manual user action --> G[History Entry: Attributed to user]
Loading

Reviews (1): Last reviewed commit: "docs(anomalies): note scan-triggered sta..." | Re-trigger Greptile

Comment thread docs/anomalies/details/insights.md Outdated
Comment on lines 61 to 63
!!! note
- Archived anomalies cannot be edited — restore the anomaly first if you need to modify the description
- Archived anomalies cannot be edited. Restore the anomaly first if you need to modify the description
- All changes to the description are tracked in the **History** section, maintaining a complete audit trail of modifications
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The first bullet is now two full sentences after the em-dash was replaced, but the sentence is missing a trailing period. The second bullet (unchanged) has the same issue — both bullets are inconsistent with the standard sentence-ending style used throughout the rest of the document.

Suggested change
!!! note
- Archived anomalies cannot be edited — restore the anomaly first if you need to modify the description
- Archived anomalies cannot be edited. Restore the anomaly first if you need to modify the description
- All changes to the description are tracked in the **History** section, maintaining a complete audit trail of modifications
!!! note
- Archived anomalies cannot be edited. Restore the anomaly first if you need to modify the description.
- All changes to the description are tracked in the **History** section, maintaining a complete audit trail of modifications.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant