Skip to content

Commit e900853

Browse files
committed
add images in reference docs
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent f5f8ee3 commit e900853

5 files changed

Lines changed: 13 additions & 2 deletions
154 KB
Loading
50.7 KB
Loading
247 KB
Loading
21.7 KB
Loading

docs/reference-policy-rules.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ Policy rules are configured per dataspace using the ``policy_rules_config`` JSON
118118
in the **Dataspace Configuration** form, accessible from the Admin interface under
119119
**Dataspaces > Dataspace configurations**.
120120

121+
.. image:: images/reference-policy-rules/dataspace-configuration-policy-rules-config.jpg
122+
121123
Each entry in the JSON object is keyed by the rule type and supports three options:
122124

123125
.. list-table::
@@ -201,14 +203,19 @@ any of the following changes occur:
201203

202204
Rules can also be re-evaluated on demand in two ways:
203205

204-
- From the **compliance tab** of a product detail page, using the re-evaluate button
205-
next to the policy violations panel.
206206
- From the **Product Administration** form in the Admin interface, using the
207207
**Evaluate policy rules** bulk action on the product list.
208+
- From the **compliance tab** of a product detail page, using the re-evaluate button
209+
next to the policy violations panel.
210+
211+
.. image:: images/reference-policy-rules/manual-reevaluation-button.jpg
212+
:width: 400
208213

209214
5. Compliance Tab
210215
-----------------
211216

217+
.. image:: images/reference-policy-rules/compliance-tab-policy-violations.jpg
218+
212219
The **Compliance** tab on each product detail page displays an overview of active
213220
policy violations. For each triggered rule, the table shows:
214221

@@ -225,6 +232,10 @@ warning-severity rules are triggered.
225232
Clicking the **info icon** next to the panel title opens a modal listing all configured
226233
rules with their current status (Triggered, OK, or Disabled).
227234

235+
.. image:: images/reference-policy-rules/compliance-tab-policy-rules.jpg
236+
:width: 500
237+
:align: center
238+
228239
6. Webhook Notifications
229240
------------------------
230241

0 commit comments

Comments
 (0)