Skip to content

Commit 938a0df

Browse files
committed
add images
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent 183b304 commit 938a0df

7 files changed

Lines changed: 33 additions & 3 deletions
164 KB
Loading
83.1 KB
Loading
142 KB
Loading
13.1 KB
Loading
7.82 KB
Loading
269 KB
Loading

docs/tutorial-7-policy-rules.rst

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _user_tutorial_7_policy_rules:
2-
31
Tutorial 7 - Managing Policy Violations
42
=======================================
53

@@ -19,6 +17,8 @@ Sign into DejaCode.
1917

2018
1. From the main menu, navigate to the :guilabel:`Compliance Dashboard`.
2119

20+
.. image:: images/tutorial-7-policy-rules/compliance-dashboard.jpg
21+
2222
2. The dashboard lists all your products with their compliance metrics. Look at the
2323
**Policy violations** column to see which products have active violations.
2424

@@ -30,6 +30,8 @@ Sign into DejaCode.
3030

3131
The **Policy violations** panel shows the active violations for the product.
3232

33+
.. image:: images/tutorial-7-policy-rules/compliance-tab-policy-violations.jpg
34+
3335
For each triggered rule, the table shows:
3436

3537
- The rule label and severity, color-coded as red (error) or yellow (warning).
@@ -44,14 +46,22 @@ if only warning rules are triggered.
4446
.. tip::
4547
Click the info icon next to the panel title to open a modal listing all active
4648
rules with their current status: **Triggered** or **OK**. This gives you a full
47-
picture of your compliance posture at a glance.
49+
picture of your overall compliance status at a glance.
50+
51+
.. image:: images/tutorial-7-policy-rules/policy-rules-modal.jpg
52+
:width: 400
53+
:align: center
4854

4955
3. Drill Into Affected Packages
5056
-------------------------------
5157

5258
1. In the **Policy violations** table, click the count in the **In violation** column
5359
for the rule you want to investigate.
5460

61+
.. image:: images/tutorial-7-policy-rules/violation-count-link.jpg
62+
:width: 140
63+
:align: center
64+
5565
2. The :guilabel:`Inventory` tab opens pre-filtered to show only the packages that
5666
triggered that rule.
5767

@@ -70,8 +80,28 @@ by completing a vulnerability analysis.
7080
3. For each vulnerability, click :guilabel:`Edit analysis` and set the analysis state
7181
to a terminal value such as **Resolved** or **Not affected**.
7282

83+
.. image:: images/tutorial-7-policy-rules/vulnerability-analysis-form.jpg
84+
:width: 400
85+
:align: center
86+
7387
.. seealso::
7488
Refer to :ref:`how_to_4` for a detailed guide on vulnerability analysis.
7589

7690
Once all vulnerabilities on a package have a terminal analysis, that package is no
7791
longer counted as a violation for the **Vulnerability Unresolved** rule.
92+
93+
5. Re-evaluate and Confirm
94+
--------------------------
95+
96+
After correcting the underlying condition, trigger a manual re-evaluation to update
97+
the violation count immediately rather than waiting for the next automatic run.
98+
99+
1. Return to the :guilabel:`Compliance` tab of the product.
100+
2. Click the re-evaluate button next to the **Policy violations** panel header.
101+
102+
.. image:: images/tutorial-7-policy-rules/reevaluate-button.jpg
103+
:width: 200
104+
:align: center
105+
106+
3. The panel refreshes with updated violation counts. Rules whose conditions are no
107+
longer met are cleared from the table.

0 commit comments

Comments
 (0)