Skip to content

Commit f6e7650

Browse files
committed
add cross chapter references
Signed-off-by: tdruez <tdruez@aboutcode.org>
1 parent 72150a7 commit f6e7650

5 files changed

Lines changed: 37 additions & 45 deletions

docs/howto-4-product-vulnerability-analysis.rst

Lines changed: 15 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ Overview
1111

1212
Product Vulnerability Analysis in DejaCode helps teams assess, review, and manage
1313
vulnerabilities specific to individual Products. The platform supports detailed
14-
analysis workflows, data propagation across related products, and integration with
15-
external tools via the **REST API**.
14+
analysis workflows and data propagation across related products.
1615

1716
1. Accessing Product Vulnerability Analysis
1817
-------------------------------------------
@@ -39,36 +38,12 @@ vulnerability, enabling in-depth review and understanding of its potential impac
3938

4039
.. image:: images/howto-4-product-vulnerability-analysis/vulnerabilities-tab.jpg
4140

42-
Each entry includes the following information:
43-
44-
- **Vulnerability ID**:
45-
A unique identifier prefixed with "VCID-", such as **VCID-2024-0001**, ensuring
46-
traceability.
47-
- **Aliases**:
48-
Alternate identifiers for the vulnerability, including **CVE identifiers**
49-
(e.g., **CVE-2019-17571**).
50-
- **Severity Levels**:
51-
Categorized as **critical**, **high**, **medium**, or **low**, based on potential
52-
impact.
53-
- **Exploitability Score**:
54-
Indicates the likelihood of exploitation, with three levels:
55-
56-
- **0.5**: No known exploits.
57-
- **1.0**: Potential exploits exist.
58-
- **2.0**: Known exploits are available.
59-
60-
- **Risk Score**:
61-
A value between **0.0** and **10.0**, representing the overall risk posed by the
62-
vulnerability.
63-
This score is calculated by multiplying the highest severity with its weight and
64-
the exploitability score, capped at **10.0**.
65-
- **Affected Packages**:
66-
Links to the affected packages and their versions.
41+
Each entry includes the vulnerability ID, its aliases, severity, exploitability, and
42+
risk score, along with links to the affected packages.
6743

68-
.. note::
69-
All vulnerability details, including analysis results and propagation status, are
70-
accessible through the **REST API**, enabling automated workflows and seamless
71-
integration with external tools.
44+
.. seealso::
45+
Refer to :ref:`reference_vulnerability_management` for a complete description of
46+
these fields and how the risk score is calculated.
7247

7348
3. Conducting Analysis
7449
----------------------
@@ -158,10 +133,6 @@ To analyze a vulnerability effectively:
158133
6. **Save Changes**:
159134
Save your analysis to ensure it is available for reference and propagated as needed.
160135

161-
.. note::
162-
The analysis data is also accessible via the **REST API**, making it possible to
163-
integrate with automated tools and workflows.
164-
165136
4. Propagating Analysis Across Products
166137
---------------------------------------
167138

@@ -177,15 +148,16 @@ To streamline reviews, DejaCode supports analysis data propagation:
177148
5. Leveraging REST API for Automation
178149
-------------------------------------
179150

180-
The **REST API** provides full access to vulnerability analysis data, enabling
181-
programmatic workflows such as:
182-
183-
- Querying vulnerabilities linked to specific Products.
184-
- Automating analysis result updates.
151+
Vulnerability analyses are available at ``/api/v2/vulnerability_analyses/``, supporting
152+
create, retrieve, update, and list operations. Use it to query analyses for specific
153+
products or packages, and to automate analysis updates as part of your own workflows.
185154

186-
Refer to the **API documentation** from the **"Tools" menu** for detailed guidance on
187-
using these endpoints.
155+
.. seealso::
156+
Refer to the **API documentation** from the **"Tools" menu** for the full list of
157+
fields and filters.
188158

189159
.. seealso::
190160
Explore the :ref:`reference_vulnerability_management` chapter for an overview of
191-
related features.
161+
related features. If you are looking for automated, rule-based recommendations
162+
instead of manual review, refer to :ref:`reference_vulnerability_triage` and
163+
:ref:`how_to_7`.

docs/reference-vulnerability-management.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This documentation outlines how vulnerabilities are **collected**, **displayed**
1313
Introduction
1414
------------
1515

16-
DejaCodes vulnerability management system relies on the **VulnerableCodeDB** service
16+
DejaCode's vulnerability management system relies on the **VulnerableCodeDB** service
1717
to collect and process vulnerability data. This service is integrated into DejaCode to
1818
provide seamless tracking and management of vulnerabilities associated with software
1919
packages and components.
@@ -191,6 +191,9 @@ For a step-by-step guide on using these features, refer to the dedicated
191191
For automated compliance monitoring of vulnerability exposure across your products,
192192
refer to :ref:`reference_policy_rules` and :ref:`how_to_6`.
193193

194+
For automated detection and remediation recommendations based on configurable rules,
195+
refer to :ref:`reference_vulnerability_triage` and :ref:`how_to_7`.
196+
194197
6. Configuration Settings
195198
-------------------------
196199

docs/reference-vulnerability-triage.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,10 @@ analysis, it becomes user-owned and the engine will not modify it again.
205205
Analysis Presets are managed in the Admin interface under
206206
:guilabel:`Vulnerabilities > Analysis Presets`.
207207

208+
.. seealso::
209+
Refer to :ref:`how_to_4` for the meaning of each analysis field (State,
210+
Justification, Responses, Detail).
211+
208212
4.3 Request Template
209213
^^^^^^^^^^^^^^^^^^^^
210214

docs/tutorial-4-vulnerabilities.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ Conduct Vulnerability Analysis
7070

7171
.. image:: images/tutorial-4-vulnerabilities/vulnerabilities-tab-with-analysis.jpg
7272

73+
.. seealso::
74+
Refer to :ref:`how_to_4` for a detailed guide on each analysis field and its
75+
meaning.
76+
7377
Export CycloneDX SBOM with VEX
7478
------------------------------
7579

@@ -81,3 +85,8 @@ Export CycloneDX SBOM with VEX
8185

8286
2. The analysis details you provide for product package vulnerabilities are
8387
included in the ``vulnerabilities`` section of the CycloneDX VEX output.
88+
89+
.. seealso::
90+
Once your administrator has configured triage rulesets for your Dataspace, this
91+
manual review is complemented by automated remediation recommendations. Refer to
92+
:ref:`user_tutorial_8_vulnerability_triage` to get started.

docs/tutorial-8-vulnerability-triage.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _user_tutorial_8_vulnerability_triage:
2+
13
Tutorial 8 - Vulnerability Triage
24
=================================
35

@@ -9,7 +11,9 @@ mean, recording your vulnerability analysis, and tracking the associated request
911
.. seealso::
1012
Refer to :ref:`reference_vulnerability_triage` for a complete description of all
1113
available rules, actions, and triage record lifecycle. If you are an administrator
12-
and need to create or configure rulesets, refer to :ref:`how_to_7`.
14+
and need to create or configure rulesets, refer to :ref:`how_to_7`. If this is your
15+
first time reviewing a product's vulnerabilities, start with
16+
:ref:`user_tutorial_4_vulnerabilities`.
1317

1418
Sign into DejaCode.
1519

0 commit comments

Comments
 (0)