Skip to content

Commit b85f16e

Browse files
committed
Fix docs typo and CI docs validation error
Signed-off-by: ziad hany <ziadhany2016@gmail.com>
1 parent d105b22 commit b85f16e

8 files changed

Lines changed: 49 additions & 28 deletions

docs/source/advisory-package-curation.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
Advisory Package Curation
44
=========================
55

6-
Follow these steps to curate the packages associated with an advisory:
6+
Follow these steps to curate the package versions associated with
7+
vulnerability advisories:
78

89
.. image:: images/advisory-package-curation.png
910

@@ -21,16 +22,19 @@ Follow these steps to curate the packages associated with an advisory:
2122

2223
.. note::
2324

24-
Click **Select value** multiple times to cycle through the available statuses (**AFFECTED**, **FIXED**, and **UNAFFECTED**).
25+
Click **Select value** multiple times to cycle through the available
26+
statuses (**AFFECTED**, **FIXED**, and **UNAFFECTED**).
2527

26-
Alternatively, if one of the suggested advisories is correct, click **Pick this** to automatically apply the recommended package version information.
28+
- if one of the suggested advisories is correct, click **Pick this** to automatically
29+
apply the advisory package versions statuses.
2730

2831
.. image:: images/package_pick_this.png
2932

30-
3. Click **Next item**. If the button is available, repeat steps 2–3 for each remaining package.
33+
3. Click **Next item**. If the button is available, repeat steps 2–3 for each
34+
remaining package.
3135

3236
.. image:: images/package_next_item.png
3337

3438
4. After reviewing all packages, click **Submit** to save and complete the package curation.
3539

36-
.. image:: images/package_submit.png
40+
.. image:: images/package_submit.png

docs/source/advisory-severity-curation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Advisory Severity Curation
44
==========================
55

6-
Follow these steps to curate the severity for advisories:
6+
Follow these steps to curate the severity associated with vulnerability advisories:
77

88
.. image:: images/advisory-severity-curation.png
99

@@ -21,4 +21,4 @@ Follow these steps to curate the severity for advisories:
2121

2222
4. Once you have curated all advisories, click **Submit**
2323

24-
.. image:: images/severity_submit-button.png
24+
.. image:: images/severity_submit.png

docs/source/advisory-todos.rst

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,50 @@ Advisory Todos
44
==============
55

66
Overview
7-
----------
8-
The Advisory To-Dos queue contains security advisories that require manual review to improve the quality and
9-
accuracy of vulnerablecode data
7+
--------
8+
9+
The Advisory To-Dos queue contains security advisories that require
10+
manual review to improve the quality and accuracy of VulnerableCode
11+
data.
1012

1113
Supported Advisory Curation Types
12-
------------------------------------
14+
---------------------------------
1315

14-
Our advisory curation process supports enriching and validating the following vulnerability advisory metadata, depending on the information available from trusted sources:
16+
Our advisory curation process supports enriching and validating the
17+
following vulnerability advisory metadata, depending on the information
18+
available from trusted sources:
1519

1620
* **Package Curation**: See :ref:`advisory-package-curation`.
1721

1822
- Advisories with conflicting **fixed** package versions.
1923
- Advisories with conflicting **affected** package versions.
20-
- Advisories with conflicting **affected** and **fixed** package versions.
21-
- *(Not currently supported)* Advisories missing affected package versions.
22-
- *(Not currently supported)* Advisories missing fixed package versions.
23-
- *(Not currently supported)* Advisories missing both affected and fixed package versions.
24+
- Advisories with conflicting **affected** and **fixed** package
25+
versions.
26+
- *(Not currently supported)* Advisories missing affected package
27+
versions.
28+
- *(Not currently supported)* Advisories missing fixed package
29+
versions.
30+
- *(Not currently supported)* Advisories missing both affected and
31+
fixed package versions.
32+
33+
* **Severity Curation**: Advisories with conflicting CVSS vectors
34+
(CVSSv3, CVSSv3.1, and CVSSv4). See
35+
:ref:`advisory-severity-curation`.
36+
37+
* **Weakness Curation**: Advisories with conflicting Common Weakness
38+
Enumeration (CWE) identifiers. See
39+
:ref:`advisory-weakness-curation`.
2440

25-
* **Severity Curation**: Advisories with conflicting CVSS vectors (CVSSv3, CVSSv3.1, CVSSv4, ...) . See :ref:`advisory-severity-curation`.
26-
* **Weakness Curation**: Advisories with conflicting Common Weakness Enumeration (CWE) identifiers. See :ref:`advisory-weakness-curation`.
2741
* **Summary Curation**: *(Not currently supported).*
2842

29-
Each curation guide provides detailed instructions for reviewing advisories in the corresponding curation queue.
43+
Each curation guide provides detailed instructions for reviewing
44+
advisories in the corresponding curation queue.
3045

3146
Accessing the Advisory To-Dos Queue
3247
-----------------------------------
3348

34-
1. Go to https://public.vulnerablecode.io/.
49+
1. Go to `public.vulnerablecode.io
50+
<https://public.vulnerablecode.io/>`_.
3551

3652
2. Click **Advisory To-Dos**.
3753

@@ -41,6 +57,7 @@ Accessing the Advisory To-Dos Queue
4157

4258
.. image:: images/continue-button.png
4359

44-
4. Search for advisories by **alias**, or filter the list by **Resolved** status or **issue type**.
60+
4. Search for advisories by **Alias**, or filter the list by
61+
**Resolved status** or **Issue type**.
4562

4663
.. image:: images/advisory-to-do-dashbaord.png

docs/source/advisory-weakness-curation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
Advisory Weakness Curation
44
===========================
55

6-
Follow these steps to curate the `Common Weakness Enumeration (CWE) <https://cwe.mitre.org/>`_ associated with an advisories:
6+
Follow these steps to curate the `Common Weakness Enumeration (CWE) <https://cwe.mitre.org/>`_ associated with vulnerability advisories:
77

88
.. image:: images/advisory-weakness-curation.png
99

1010
1. Click the Alias you want to curate, for example, ``CVE-2022-24512``.
1111

12-
2. Select the appropriate CWE status (APPLICABLE or NOT APPLICABLE) for the selected CWE ID.
12+
2. Select the appropriate CWE status (``APPLICABLE`` or ``NOT APPLICABLE``) for the selected CWE ID.
1313

1414
.. image:: images/weakness_select_value.png
1515

@@ -19,4 +19,4 @@ Follow these steps to curate the `Common Weakness Enumeration (CWE) <https://cwe
1919

2020
3. Click **Submit**.
2121

22-
.. image:: images/weakness_submit.png
22+
.. image:: images/weakness_submit.png
File renamed without changes.

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ vulnerabilities with comprehensive information from upstream and downstream publ
5959
sources including packages affected by a vulnerability advisories and packages that fix a
6060
vulnerability advisory.
6161

62-
There is a `public vulnerableCode database <https://public.vulnerablecode.io/>`_
62+
There is a `Public VulnerableCode Database <https://public.vulnerablecode.io/>`_
6363
and the project also provides the tools to build your own instance of the database.
6464

6565
Documentation overview
@@ -122,7 +122,7 @@ Consult the reference to understand VulnerableCode concepts.
122122
Advisory Curation
123123
~~~~~~~~~~~~~~~~~
124124

125-
Learn how to review and enrich vulnerability advisory data.
125+
Learn how to review and curate vulnerability advisories.
126126

127127
- :ref:`advisory_todos`
128128

docs/source/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ a CPE. This makes answers to questions such as "Is package *foo* vulnerable
9393
to vulnerability *bar*?" more accurate and easier to interpret.
9494

9595
The primary access to VulnerableCode data is through a REST API, but there
96-
is also a Web UI for searching and browsing vulnerabilities by package
97-
or by vulnerability. For the initial releases both access modes are
96+
is also a Web UI for searching and browsing vulnerability advisories by package.
97+
For the initial releases both access modes are
9898
read-only, but our longer-term goal is to enable community curation of
9999
the data including addition of new packages and vulnerabilities, and
100100
reviewing and updating their relationships.

0 commit comments

Comments
 (0)