Skip to content

QUA-1518: Add the force refresh for anomaly source records#1073

Open
RafaelOsiro wants to merge 12 commits intomainfrom
qua-1518-add-the-force-refresh-for-anomaly-source-records
Open

QUA-1518: Add the force refresh for anomaly source records#1073
RafaelOsiro wants to merge 12 commits intomainfrom
qua-1518-add-the-force-refresh-for-anomaly-source-records

Conversation

@RafaelOsiro
Copy link
Copy Markdown
Contributor

@RafaelOsiro RafaelOsiro commented Mar 16, 2026

Overview

This PR rewrites the Anomaly Insights and Source Records documentation pages with updated screenshots, step-by-step flows, MDI icons, permission banners, and consistent formatting across all sections.

Key Changes

  • Anomaly Insights page rewrite: Add Summary, Description, Failed Checks, Source Records, Tickets, and History sections with detailed step-by-step instructions and screenshots
  • Tickets section: Document linking, creating (ServiceNow and Jira), viewing, and unlinking tickets with permission banners and form field tables
  • History section: Document adding, editing, and deleting comments with per-action permission banners
  • Source Records page rewrite: Rewrite Force Refresh, Download, and Masked Fields sections with consistent text and shared images from Insights
  • Masked Fields documentation: Add Revealing Masked Values and Masking Audit Log subsections with step-by-step flows
  • MDI icons standardization: Add icons to all button references (refresh, download, send, pencil, trash, ticket, plus-circle, eye, shield-lock, history, dots-vertical, arrow-top-right, close-thick)
  • Permission banners: Add info banners for role requirements (Tickets, Comments) and warning banners for blocking conditions (archived anomalies, ticketing integration)
  • Team permissions update: Add anomaly-related permission rows (Edit Description, Add Comment, Link/Create/Unlink Tickets)
  • Screenshot renaming: Rename macOS default screenshot names to descriptive SEO-friendly names
  • Broken links fixed: Fix relative path to mask-a-field.md in source-record.md and archive-anomalies.md in status.md
  • Summary table update: Update example values to match current screenshots (COVID-19 Data datastore)

Screenshots

N/A — This PR is entirely documentation with embedded screenshots throughout the pages.

Restructure docs/anomalies/ into subfolders (details/, manage-anomalies/)
matching the mkdocs.yml nav tree, following the field-status pattern.
Update all internal cross-references and image paths accordingly.
Relocate all anomaly-related images to assets/anomalies/ mirroring
the docs content structure. Rename datastore-light-1.png to datastore-1.png
removing the light/dark suffix.
Delete orphan images in assets/anomalies/ that are not referenced
by any documentation file.
…ructure

Fix cross-references in checks/ and explore/ pointing to moved anomaly
pages. Add redirect_maps in mkdocs.yml for all 13 renamed anomaly paths.
@RafaelOsiro RafaelOsiro self-assigned this Mar 16, 2026
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label Mar 16, 2026
Delete legacy archived assets that are not referenced by any
documentation file.
Add Summary, Description, Failed Checks, Source Records, Tickets, and
History sections with step-by-step flows, proper MDI icons, permission
banners, and renamed screenshots for SEO. Update team-permissions.md
with anomaly-related permission rows. Fix summary table values to match
current screenshots and standardize button references.
…ields sections

- Rewrite Source Record Visualization to reference Maximum Source Examples
  per Anomaly setting with link to scan configuration
- Replace Force Refresh and Download sections with consistent text and
  images from the Insights page
- Add Revealing Masked Values subsection with step-by-step flow and
  screenshots (toggle, confirmation dialog)
- Add Masking Audit Log subsection with step-by-step flow and screenshots
  (audit log button, audit log panel)
- Add MDI icons: shield-lock-outline (toggle), eye (reveal), history
  (audit log), refresh, download
- Fix broken link to mask-a-field.md (incorrect relative path)
- Fix broken link to archive-anomalies.md in status.md
- Rename 4 macOS screenshots to descriptive names for SEO
@RafaelOsiro RafaelOsiro marked this pull request as ready for review March 24, 2026 02:52
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