Skip to content

[cravex2-reachability] Add documentation for triage rules - #565

Merged
tdruez merged 7 commits into
mainfrom
370-cravex2-reachability-triage-docs
Aug 20, 2026
Merged

[cravex2-reachability] Add documentation for triage rules#565
tdruez merged 7 commits into
mainfrom
370-cravex2-reachability-triage-docs

Conversation

@tdruez

@tdrueztdruez commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Published at https://dejacode.readthedocs.io/en/latest/reference-vulnerability-triage.html, https://dejacode.readthedocs.io/en/latest/howto-7-vulnerability-triage-configuration.html and https://dejacode.readthedocs.io/en/latest/tutorial-8-vulnerability-triage.html

Issues

Vulnerability Triage Reference Documentation

  • New reference pagereference-vulnerability-triage.rst documenting the Triage Engine concept, built-in rules, triage record lifecycle, and configuration
  • Built-in rules table covering all seven rules with label, rule type, and description, plus a parameters reference for each configurable rule
  • Triage actions table listing all eight recommended actions a ruleset can produce
  • Triage record lifecycle explaining the detected, active, and deleted states
  • Configuration reference for the Triage Ruleset, Analysis Preset, and Request Template fields
  • Evaluation triggers documenting automatic, immediate re-evaluation and the evaluate_triage management command
  • REST API documenting the triage recommendations endpoint, full CRUD on rulesets and presets, the ruleset-assignment endpoint, and the vulnerability analysis enrichment fields
  • Cross-references added between this chapter and the existing vulnerability management and vulnerability analysis documentation, in both directions where relevant

How-To: Configure Vulnerability Triage

  • Admin configuration workflow covering how to create a Triage Ruleset (name, action, precedence) and enable its detection rules
  • Analysis Preset setup to auto-apply default analysis values to matched vulnerabilities
  • Request Template linking to auto-open a DejaCode Request for each new match
  • Assigning rulesets to products through the Manage Triage Rulesets panel
  • Managing precedence when multiple assigned rulesets match the same vulnerability

Tutorial: Reviewing Vulnerability Triage Recommendations

  • Reading the Recommendation column on the product Vulnerabilities tab: action, ruleset, detection date, and linked request
  • Filtering and prioritizing by triage action, risk score, and analysis state
  • Recording a vulnerability analysis, including how preset-applied values are pre-filled and marked
  • Tracking the linked Request opened automatically for a match
  • Automatic re-evaluation: no manual step, results are immediate on the next page reload

Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
@tdruez
tdruez merged commit b756179 into mainAug 20, 2026
8 checks passed
@tdruez
tdruez deleted the 370-cravex2-reachability-triage-docs branch August 20, 2026 13:56
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@tdruez