Skip to content

docs: [five-c] add tutorial and how-to documentation #418 - #558

Merged
tdruez merged 16 commits into
mainfrom
418-5c-tuto-and-how-to
Jul 27, 2026
Merged

docs: [five-c] add tutorial and how-to documentation #418#558
tdruez merged 16 commits into
mainfrom
418-5c-tuto-and-how-to

Conversation

@tdruez

@tdruez tdruez commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Published at https://dejacode.readthedocs.io/en/latest/howto-6-policy-rules-configuration.html and https://dejacode.readthedocs.io/en/latest/tutorial-6-vuln-report.html

Issues

How-To: Configure Policy Rules

  • Admin configuration workflow covering how to access the Policy Rules Configuration section in the Dataspace admin
  • Enable and disable rules via the Enable this rule checkbox, with automatic re-evaluation on save
  • Threshold configuration to tolerate a number of violations before a rule is triggered
  • Vulnerability rule parameters covering Min Risk Score for Vulnerability Detected and Max Days / Min Risk Score for Vulnerability Stale
  • Compliance Dashboard and drill-down explaining how to identify products with active violations and navigate to the compliance tab
  • Webhook notifications summarizing the available policy events and linking to the Webhook integration page

Tutorial: Managing Policy Violations

  • Compliance Dashboard as the entry point to identify products with active policy violations
  • Policy violations panel reviewing triggered rules with their severity, violation count, and detection date
  • Policy rules modal showing the status of all active rules (Triggered or OK)
  • Inventory drill-down filtering packages by triggered rule to investigate violations
  • Resolving a violation with a concrete example using vulnerability analysis to clear a Vulnerability Unresolved violation
  • Manual re-evaluation to confirm the violation is cleared without waiting for the next automatic run

tdruez added 9 commits July 27, 2026 09:53
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>
Signed-off-by: tdruez <tdruez@aboutcode.org>
Signed-off-by: tdruez <tdruez@aboutcode.org>
@tdruez tdruez changed the title docs: [five-c] add usage and configuration documentation #418 docs: [five-c] add tutorial and how-to documentation #418 Jul 27, 2026
tdruez added 7 commits July 27, 2026 13:01
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 c3399c8 into main Jul 27, 2026
8 checks passed
@tdruez
tdruez deleted the 418-5c-tuto-and-how-to branch July 27, 2026 11:55
Sign up for free to 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