QUA-1756: Add Quality Check Ownership documentation#1148
Open
RafaelOsiro wants to merge 4 commits into
Open
Conversation
Captures conventions established across recent reviews: page-type layouts (Overview/Getting Started/Introduction/How It Works/Examples/ How-tos/API/FAQ/Permissions), H1 and card icon rules, inline action icon pattern, permission matrix and support table icons, em-dash and sensitive-info bans, asset layout and naming, team permission vs user role terminology, and workflow rules (validate against remote, do not run mkdocs build unprompted, batch pre-commit, pre-commit needs venv). Also applies the H1 brick icon convention to the Data Quality Checks Overview page header.
Adds the Quality Check Ownership sub-tree under Data Quality Checks covering the Owner field defaults, the three transfer modes (explicit, implicit, Drafter activation), permissions, notifications, history tracking, and filtering. Includes: - Getting Started hub with Deep Dive / How-tos / API & FAQ card grid - Deep Dive (Introduction, How It Works, Examples) - How-tos (Change Owner, Bulk Change Owner) with per-entry-point tabs - API reference with Create / Update / Filter endpoints and bulk all-or-nothing semantics - FAQ grouped by Defaults / Transfers / Permissions / Notifications / Filtering / History / API - Step-by-step screenshots for both how-tos and a Getting Started hero - mkdocs.yml nav entries
RafaelOsiro
requested review from
Hitsu-360,
ets,
gasscoelho,
josecsotomorales,
pelegolas9 and
shindiogawa
Contributor
Greptile SummaryThis PR adds a complete Quality Check Ownership documentation sub-tree under Data Quality Checks, covering seven new pages (Getting Started hub, three Deep Dive pages, two How-tos, one API reference, and one FAQ), 39 step screenshots, and a CLAUDE.md update capturing documentation conventions. It also applies the H1 brick icon convention to the existing Checks Overview page.
Confidence Score: 5/5This is a documentation-only PR with no code logic changes; it is safe to merge. All seven new pages follow the CLAUDE.md conventions precisely: correct H1/card icons, same-tab links on Getting Started, target=_blank on all other cross-links, no em-dashes, no internal implementation terms, correct Member-role vs team-permission terminology throughout, and an accurate API error table. The mkdocs.yml nav hierarchy matches the page structure. No broken cross-references or missing assets were found. No files require special attention. Important Files Changed
Reviews (2): Last reviewed commit: "Merge branch 'main' into qua-1756-qualit..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Greptile flagged that the 400/422 rows incorrectly classified two scenarios. Verified against controlplane@develop: - AuthUnauthorizedException maps to 403, not 422, so the Drafter-permission case belongs only in the 403 row. - FastAPI Pydantic/JSON-parse failures map to 422, not 400, so owner_id type errors move to 422; 400 now describes business-logic conflicts (e.g., invalid status transitions).
Contributor
Author
|
@greptileai review |
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
Adds the Quality Check Ownership documentation sub-tree under Data Quality Checks, covering the Owner field defaults, the three transfer modes (explicit, implicit, and Drafter activation), permissions, notifications, history, and filtering. Includes a Getting Started hub, Deep Dive pages, two how-tos with per-entry-point tabs, an API reference, and an FAQ.
Also captures the doc conventions surfaced during this work in CLAUDE.md (page structure, H1/card icons, inline action icons, permission tables, language and style, asset layout, terminology, and workflow rules).
Key Changes
owner_idfield reference, bulk all-or-nothing semantics, and a sharpened 400/422 error table. Verified againstcontrolplane@develop.Pages to Test
:material-book-open-page-variant:; intro paragraph; hero screenshot;!!! info "Permissions"block; three H2 sections (Deep Dive / How-tos / API & FAQ) separated by HR dividers; card icons mirror destination H1 icons; links open in the same tab.:material-book-open-variant:; Overview / Why this matters / Transfer modes at a glance / Next Steps sections; single Next Steps grid (How It Works + Examples); no screenshots.:material-file-cog:; full mechanics (defaults, three transfer modes, permissions table, notifications, history, owner-vs-assignee comparison table, filtering);disables Qualytics as a selectable ownerwording in the Transfer-away warning; Drafter activation explained as "cannot edit it".:material-text-box-edit-outline:; five scenarios (Onboarding / Handoff / Notifications / Compliance audit / Draft promotion) using Context. + What happens. + Why it works. structure;Explore > Checksmenu label.!!! noteinside the Explore tab; trailing!!! infocovers Author/Drafter permissions +Qualyticspinned at top +disablesafter transfer.!!! warning "Bulk replaces, not merges".:material-api:;!!! tiplinking to demo.qualytics.io/api/docs;!!! note "Permissions"(Member role + Viewer/Author team permissions); field reference table forowner_idlinking to AI Managed; Create / Update / Filter sections with cURL examples; PUT example includesdescription(required);!!! note "Bulk is all-or-nothing"under bulk PATCH; sharpened 400 vs 422 error rows.:material-help-circle-outline:; no tip banner; Q&A grouped by Defaults / Transfers / Permissions / Notifications / Filtering / History / API; "Can I transfer ownership back to Qualytics?" answer saysdisables(consistent with how-it-works and change-owner); PUT example in API question includesdescription+owner_id.:material-book-alphabet:icon next to "Checks Overview".:material-cog:/:material-pencil-outline:/:material-dots-vertical:/:material-square-edit-outline:icons in step bodies pick up the default foreground color.