Skip to content

Commit 18dbee4

Browse files
authored
Tweak CEL expression docs (#19)
Clearly separates expression usages for policy conditions from those for notification filters. Adds a general CEL reference that both contexts can refer to instead of duplicating the same information across pages. Signed-off-by: nscuro <nscuro@protonmail.com>
1 parent 63ded01 commit 18dbee4

9 files changed

Lines changed: 629 additions & 561 deletions

File tree

docs/concepts/vulnerability-policies.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# About vulnerability policies
22

33
Vulnerability policies let organisations encode how specific vulnerabilities should be triaged across
4-
the portfolio. Where a [standard policy](../reference/vulnerability-policies.md) raises violations, a vulnerability policy acts
4+
the portfolio. Where a [standard policy](../reference/policies/index.md) raises violations, a vulnerability policy acts
55
on the finding itself. It applies an analysis (state, justification, vendor response, details),
66
optionally overrides the vulnerability's ratings, and can suppress the finding altogether.
77

@@ -65,7 +65,7 @@ time-bounded policies for temporary suppressions, embargoes, or phased rollouts.
6565
### Operation Modes
6666

6767
Every policy has an operation mode that determines what happens when its condition matches.
68-
Refer to the [operation modes reference](../reference/vulnerability-policies.md#operation-modes)
68+
Refer to the [operation modes reference](../reference/policies/index.md#operation-modes)
6969
for the full list.
7070

7171
*Log* mode is particularly useful when introducing a new policy. It lets you observe how often a
@@ -74,7 +74,7 @@ to *Apply*.
7474

7575
## Further Reading
7676

77-
* [Vulnerability policies reference](../reference/vulnerability-policies.md) for field
77+
* [Vulnerability policies reference](../reference/policies/index.md) for field
7878
definitions, condition variables, the bundle YAML schema, and sync rules.
7979
* [Managing vulnerability policies](../guides/user/managing-vulnerability-policies.md)
8080
for step-by-step procedures.

docs/guides/user/managing-vulnerability-policies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ permission is `POLICY_MANAGEMENT`, or one of the finer-grained `POLICY_MANAGEMEN
66

77
For background on what vulnerability policies are and how they work, see the
88
[concepts page](../../concepts/vulnerability-policies.md). For field definitions and the bundle YAML
9-
schema, see the [reference page](../../reference/vulnerability-policies.md).
9+
schema, see the [reference page](../../reference/policies/index.md).
1010

1111
![Vulnerability policy list](./images/managing-vulnerability-policies/vuln-policies_list.png)
1212

@@ -38,7 +38,7 @@ read-only and must be changed at the bundle source.
3838
## Configuring the Bundle Source
3939

4040
Configure the bundle URL and (optionally) credentials on the API server. Refer to the
41-
[bundle configuration properties](../../reference/vulnerability-policies.md#bundle-configuration)
41+
[bundle configuration properties](../../reference/policies/index.md#bundle-configuration)
4242
for the full list.
4343

4444
Once the URL is configured, Dependency-Track fetches the bundle on the configured schedule. A bundle

docs/reference/.pages

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav:
77
- Notifications: notifications
88
- Vulnerability analysis:
99
- Vulnerability analyzers: analyzers.md
10-
- Vulnerability policies: vulnerability-policies.md
10+
- Vulnerability policies: policies
1111
- CEL expressions: cel-expressions.md
1212
- Access control:
1313
- Permissions: permissions.md

0 commit comments

Comments
 (0)