QUA-1756: Restructure anomaly docs and document Assignees#1121
Draft
RafaelOsiro wants to merge 7 commits into
Draft
QUA-1756: Restructure anomaly docs and document Assignees#1121RafaelOsiro wants to merge 7 commits into
RafaelOsiro wants to merge 7 commits into
Conversation
RafaelOsiro
requested review from
Hitsu-360,
ets,
gasscoelho,
josecsotomorales,
pelegolas9 and
shindiogawa
3 tasks
- Remove em-dashes across anomaly docs (status, source-record, insights,
detection, overview, fingerprints).
- Fix tag-edit permission in edit-tags how-to: Editor -> Author, aligning
with the backend (PUT /api/anomalies/{id} requires Author baseline;
only description additionally requires Editor).
- Add cross-link hub pointer in edit-description so legacy edit-anomalies
arrivals find edit-tags and add-assignee.
- Flatten redundant ../deep-dive/assignees.md self-reference in insights.
- Add 6 missing legacy redirects (anomalies-in-datastore, anomaly-details,
manage-anomalies, overview-of-an-anomaly, universal-anomaly,
what-is-anomaly) so external links keep resolving.
RafaelOsiro
force-pushed
the
qua-1756-anomaly-assignees
branch
from
e423a82 to
27da3a6
Compare
- Normalize team permission terminology ("<level> team permission")
across Deep Dive assignees, add/remove/bulk how-tos, API, and FAQ.
- Fix factually wrong hard-delete constraint in API: hard-delete
works on any anomaly, not just archived (validated against
controlplane).
- Refine Deep Dive assignee descriptions: avatar/name display rules,
inheritance from check defaults, notification triggers (status,
tags, description, assignees), and Author requirement on
self-assignment.
- Drop redundant H2s and "picker component" leak in add/remove/bulk
how-tos; replace with "user picker" wording.
- Standardize tab labels to "From Explore > Anomalies" and "From the
Anomaly Overview" in how-tos.
- Treat the close icon in the user picker as an icon (not a button)
in remove-assignee how-to.
- Split anomalies/how-tos/edit-tags.md into three sibling pages under
anomalies/how-tos/tags/: add-tags.md (Overview/Explore tabs),
remove-tags.md (Overview/Explore tabs, screenshots TBD), and
bulk-edit.md (Datastore/Check Template tabs).
- Mirror the Assignee how-to architecture: same tabs, same step pattern,
parallel naming ("Tags field", clean +/Edit icon phrasing).
- Add mkdocs.yml nav entry "Tags" replacing the flat "Edit Tags", and
redirect anomalies/how-tos/edit-tags.md to tags/add-tags.md.
- Create docs/assets/anomalies/how-tos/shared/ for the first 6 steps of
the bulk flow (anomalies list to modal opens), reused by both
bulk-assign.md and bulk-edit.md.
- Move bulk-assign steps 1-6 (datastore + check-template) into shared/;
keep steps 7-11 inside assignee/bulk-assign/.
- Place bulk-edit-specific assets (datastore + check-template steps
7-11) inside tags/bulk-edit/ following the standard
<context>-step-N-<descriptor>.png naming.
- Update cross-links in faq.md, edit-description.md, and the bulk-assign
tip to point at the new Tags pages.
- Remove the now-stale Assign Tags section from explore/anomalies.md
and drop the associated assign-light.png and tag-light.png assets.
- Delete the legacy edit-tags-bulk/ asset folder (content migrated).
- Strip screenshots from anomalies/deep-dive/status.md and keep it
conceptual: H1 icon (mdi-alert matching the frontend
icon-anomalies.svg), Status colors reference table sourced from
frontend (consts/anomalies.ts + quasar.variables.scss), and
Open/Archived sub-status reference tables with "Anomaly Status"
column.
- Create anomalies/how-tos/filter-by-status.md as a new how-to with
two sections (Open + Archived), each with three tabs (Explore,
Datastore Anomalies tab, Check Template Anomalies tab) and two
steps per tab (click filter, pick sub-status). Each tab carries
its sub-status reference table for quick lookup.
- Place the 12 captured screenshots under
docs/assets/anomalies/how-tos/filter-by-status/ following the
<context>-<group>-step-N-<descriptor>.png pattern. Mark Container
Level and Field Level views as TODO for future capture.
- Delete the legacy Deep Dive screenshots
(deep-dive/status/{open,archive}-anomalies.png) now that the
page is screenshot-free.
- Add Filter by Status to the How-tos nav before Filter & Sort.
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
1 participant
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
Restructures the Anomalies section into Deep Dive and How-tos hubs and documents the new Assignees feature end-to-end.
Key Changes
Pages to Test
deep-dive/types.md.:material-plus-circle:icon; two tabs (Anomaly Overview / Anomaly Explore) with identical 6-step flow; singleinfoadmonition at the end covers permissions + notification rule.:material-minus-circle:icon; X-button references are labeled Remove (not "X");notecallout about self-unassignment plustipcross-link to Bulk-Assign.:material-dots-vertical-circle:icon; ellipsis button labeled Bulk menu; Step 6 mentions the in-modal overwrite alert; closingwarningflags the replace semantics.:material-api:; API docs tip banner immediately after the intro; PUT/PATCH require Author (Editor only for description); dedicated Manage assignees subsection under Update.:material-help-circle-outline:; "Can an Acknowledged anomaly go back to Active?" answers Yes; permissions answer reflects Author-base + Editor-for-description./anomalies/status/,/anomalies/types/,/anomalies/fingerprints/,/anomalies/details/insights/,/anomalies/details/source-record/, and/anomalies/manage-anomalies/<page>/should all land on their newdeep-dive/orhow-tos/URLs.