Skip to content

docs: peer review claiming, per-person assignment and the My Work queue - #15395

Merged
devGregA merged 4 commits into
DefectDojo:devfrom
devGregA:docs/owners-reviews-my-work
Jul 31, 2026
Merged

docs: peer review claiming, per-person assignment and the My Work queue#15395
devGregA merged 4 commits into
DefectDojo:devfrom
devGregA:docs/owners-reviews-my-work

Conversation

@devGregA

Copy link
Copy Markdown
Contributor

Documentation for the Pro peer-review and assignment work. Three additions, no existing content reworded beyond the insertion points.

New pages

triage_findings/findings_workflows/PRO__peer_review.md — requesting a review, claiming and releasing one, what happens to a claim when the review is cleared or the Finding is closed, the new Review Findings permission for narrowing who can be asked at all, and assigning a Finding to individual people (including how that differs from group Owners).

metrics_reports/dashboards/PRO__my_work.md — the per-user My Work queue, its five lists, and the matching dashboard widget and template.

Notifications page

Two sections added to admin/notifications/about_notifications.md:

  • Narrowing Review Request Notifications — scoping your own review-request notifications to chosen assets or asset types.
  • Work Assignment Notifications — the aggregated Work Assigned event.

Both state the trade-off explicitly, because it is surprising otherwise: narrowing suppresses the message, not the request. A reviewer who has scoped themselves out remains a requested reviewer and still sees the request in their My Work queue. The review-request section also notes that this narrowing takes precedence over the system-level override (DD_NOTIFICATIONS_SYSTEM_LEVEL_TRUMP) documented further down the same page — placed above it deliberately, since that interaction is the part a reader is most likely to trip over.

Verification

Every internal link in the new and edited pages was resolved against the content tree — all resolve. Front matter follows the surrounding PRO__ pages (audience: pro, description, weight).

Related

Implements the docs half of the Pro PR (DefectDojo-Inc/dojo-pro#2083, internal). The OSS-side review-state fix is #15394.

🤖 Generated with Claude Code

Documents the Pro review and assignment work:

- A Peer Review & Claiming page covering requesting a review, claiming and
  releasing one, the new Review Findings permission for narrowing who can
  be asked at all, and assigning a Finding to individual people.
- A My Work page describing the per-user queue and its five lists, plus
  the matching dashboard widget and template.
- Two notification sections: narrowing review-request notifications to
  chosen assets or asset types, and the aggregated Work Assigned event.

Both notification sections state the trade-off explicitly, because it is
surprising otherwise: narrowing suppresses the message, not the request.
A reviewer who has scoped themselves out remains a requested reviewer and
still sees the request in their queue. The review-request section also
notes that this narrowing takes precedence over the system-level override
documented further down the same page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
devGregA and others added 3 commits July 28, 2026 22:13
Hugo lowercases output URLs (disablePathToLower is unset), and the other
ninety-odd links to PRO__ pages in this tree are already written
lowercase. The seven uppercase targets these pages shipped with would
have 404'd on the rendered site.

They slipped through because the link check used during writing compared
both sides case-insensitively — a checker that cannot fail on exactly
this defect. Re-verified with a case-sensitive comparison of written
targets against the lowercased served URL set.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The internal-link check in the deploy job failed on one link: the
Customizable Dashboards page sets `slug: custom-dashboards` in its front
matter, so it builds at .../dashboards/custom-dashboards/ and not at the
filename-derived pro__custom_dashboards. Matches Introduction_dashboard.md,
a sibling in the same directory, which already links to ../custom-dashboards/.

Nothing else linked to that page, which is why there was no precedent to
copy from when the page was written. Worth noting for next time: the
link checker used while writing these pages derived URLs from filenames,
so it could not see a slug override — the six other links in this PR are
genuinely fine, but this one only surfaced once Hugo had built the site.
Re-checked all seven with front matter parsed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@devGregA
devGregA merged commit 5c46bb7 into DefectDojo:dev Jul 31, 2026
150 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants