Skip to content

Commit 6fa52b2

Browse files
committed
enable rules section
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent c4aa0e2 commit 6fa52b2

1 file changed

Lines changed: 17 additions & 12 deletions

File tree

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

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,24 @@ thresholds.
1515
Refer to :ref:`reference_policy_rules` for a complete description of all available
1616
rules, configuration options, and violation lifecycle.
1717

18-
Overview
19-
--------
18+
1. Access the Policy Rules Configuration
19+
----------------------------------------
2020

21-
Policy rules are configured via the ``policy_rules_config`` JSON field in the
22-
**Dataspace Configuration** form. Each rule is identified by its rule type and supports
23-
three options: ``is_active``, ``threshold``, and ``parameters``.
21+
1. From the DejaCode **Administration dashboard**, navigate to :guilabel:`Dataspaces`.
22+
2. Open your Dataspace by clicking on its name.
23+
3. Scroll down to the **Policy Rules Configuration** section.
2424

25-
1. Access the Dataspace Configuration
26-
--------------------------------------
25+
Each built-in rule is listed as a collapsible fieldset with its label and description.
2726

28-
1. From the DejaCode **Administration dashboard**, navigate to
29-
:guilabel:`Dataspaces > Dataspace configurations`.
30-
2. Open the configuration for your Dataspace.
31-
3. Locate the **Policy rules config** field.
27+
2. Enable a Rule
28+
----------------
3229

33-
The field accepts a JSON object. If it is empty, no rules are active.
30+
To activate a rule, expand its fieldset and check the :guilabel:`Enable this rule`
31+
checkbox.
32+
33+
Click :guilabel:`Save` at the bottom of the Dataspace form. DejaCode will immediately
34+
schedule a background re-evaluation of all products in the Dataspace.
35+
36+
.. note::
37+
Rules that are not enabled are skipped during evaluation and any previously open
38+
violations for those rules are automatically resolved.

0 commit comments

Comments
 (0)