Skip to content

Commit 9e4be35

Browse files
committed
add images to illustrate the docs
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent abda026 commit 9e4be35

6 files changed

Lines changed: 20 additions & 3 deletions

docs/howto-6-policy-rules-configuration.rst

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ thresholds.
2222
2. Open your Dataspace by clicking on its name.
2323
3. Scroll down to the **Policy Rules Configuration** section.
2424

25+
.. image:: images/howto-6-policy-rules-configuration/policy-rules-configuration-section.jpg
26+
2527
Each built-in rule is listed with its label, description, threshold, and optional
2628
parameters.
2729

@@ -30,6 +32,9 @@ parameters.
3032

3133
To activate a rule check the :guilabel:`Enable this rule` checkbox.
3234

35+
.. image:: images/howto-6-policy-rules-configuration/enable-rule-checkbox.jpg
36+
:width: 150
37+
3338
Click :guilabel:`Save` at the bottom of the Dataspace form. DejaCode will immediately
3439
schedule a background re-evaluation of all products in the Dataspace.
3540

@@ -69,6 +74,9 @@ For the **Vulnerability Stale** rule, two parameters are available:
6974
- :guilabel:`Min Risk Score`: only vulnerabilities at or above this score are
7075
considered. Defaults to 8.0.
7176

77+
.. image:: images/howto-6-policy-rules-configuration/vulnerability-rule-parameters.jpg
78+
:width: 300
79+
7280
5. Investigate Violations
7381
-------------------------
7482

@@ -83,13 +91,22 @@ menu) providing an overview of all products with their compliance metrics, inclu
8391
Use this view to identify at a glance which products have triggered rules and
8492
prioritize which ones to address first.
8593

94+
.. image:: images/howto-6-policy-rules-configuration/compliance-dashboard-violations-column.jpg
95+
:width: 400
96+
8697
**Compliance tab drill-down**
8798

8899
From the :guilabel:`Compliance Dashboard`, click the policy violations count on a
89-
product row to open its :guilabel:`Compliance` tab directly.
100+
product row to open its :guilabel:`Compliance` tab directly.
90101
The **Policy violations** panel lists each triggered rule with its violation count
91-
and detection date. Clicking the info icon opens a modal showing the status of all
92-
configured rules: **Triggered**, **OK**, or **Disabled**.
102+
and detection date.
103+
104+
.. image:: images/howto-6-policy-rules-configuration/compliance-tab-policy-violations.jpg
105+
106+
.. tip::
107+
To see the status of all configured rules, including those that are not triggered,
108+
click the info icon next to the panel title. A modal opens showing every rule with
109+
its current status: **Triggered**, **OK**, or **Disabled**.
93110

94111
To drill into the affected packages for a specific rule:
95112

48.1 KB
Loading
85 KB
Loading
5.07 KB
Loading
162 KB
Loading
13.8 KB
Loading

0 commit comments

Comments
 (0)