Skip to content

Commit 605a5df

Browse files
committed
Fix a typo in the docs and fix the CI
Signed-off-by: ziad hany <ziadhany2016@gmail.com>
1 parent d105b22 commit 605a5df

8 files changed

Lines changed: 12 additions & 12 deletions

docs/source/advisory-package-curation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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 vulnerability advisories:
77

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

@@ -23,7 +23,7 @@ Follow these steps to curate the packages associated with an advisory:
2323

2424
Click **Select value** multiple times to cycle through the available statuses (**AFFECTED**, **FIXED**, and **UNAFFECTED**).
2525

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

2828
.. image:: images/package_pick_this.png
2929

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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Our advisory curation process supports enriching and validating the following vu
2222
- *(Not currently supported)* Advisories missing fixed package versions.
2323
- *(Not currently supported)* Advisories missing both affected and fixed package versions.
2424

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

@@ -41,6 +41,6 @@ Accessing the Advisory To-Dos Queue
4141

4242
.. image:: images/continue-button.png
4343

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

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

docs/source/advisory-weakness-curation.rst

Lines changed: 2 additions & 2 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

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)