Skip to content

Commit 9d9d338

Browse files
committed
Fix sections, links, & references for maven
1 parent 6fb98b7 commit 9d9d338

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/design.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,19 +196,19 @@ _________________
196196
security-issues
197197
^^^^^^^^^^^^^^^
198198
The `security-issues/action.yml` creates GitHub Issues for known vulnerabilities
199-
for `maven` and `pip-audit <https://pypi.org/project/pip-audit/>`_.
199+
for `maven <https://sonatype.github.io/ossindex-maven/maven-plugin/>`_ and `pip-audit <https://pypi.org/project/pip-audit/>`_.
200200
The following steps are taken:
201201

202202
1. Convert a JSON of known vulnerabilities into a common format (`class Issue`)
203203
2. Filter out vulnerabilities which already have an existing GitHub Issue via CVE
204204
3. Create new GitHub Issues
205205
4. Return a JSON of the newly created GitHub Issues
206206

207-
Input variants
208-
~~~~~~~~~~~~~~
207+
Input Variants
208+
""""""""""""""
209209
An input variant would be passed in as a string-encoded JSON.
210210

211-
`maven` (via `mvn --batch-mode org.sonatype.ossindex.maven:ossindex-maven-plugin:audit org.sonatype.ossindex.maven:ossindex-maven-plugin:audit-aggregate`)
211+
`maven` (with `ossindex-audit <https://sonatype.github.io/ossindex-maven/maven-plugin/ossindex-audit/>`_)
212212

213213
.. code-block:: json
214214
@@ -259,7 +259,7 @@ An input variant would be passed in as a string-encoded JSON.
259259
}
260260
261261
Known Issues
262-
~~~~~~~~~~~~~
262+
""""""""""""
263263
The `security-issues/action.yml` assumes that eventually every known vulnerability will
264264
be associated with a singular CVE.
265265

0 commit comments

Comments
 (0)