diff --git a/docs/source/tutorial_add_new_importer.rst b/docs/source/tutorial_add_new_importer.rst index 9b9a13f1a..d8034bc81 100644 --- a/docs/source/tutorial_add_new_importer.rst +++ b/docs/source/tutorial_add_new_importer.rst @@ -42,12 +42,12 @@ VulnerableCode extensively uses Package URLs to identify a package. See the purl = PackageURL(name="ffmpeg", type="deb", version="1.2.3") -AdvioryData +AdvisoryData ^^^^^^^^^^^^^ ``AdvisoryData`` is an intermediate data-format, it is expected, that your importer converts the raw scraped data into ``AdvisoryData`` objects. -All the fields in ``AdvioryData`` dataclass are optional, it is the importer's resposibility to +All the fields in ``AdvisoryData`` dataclass are optional, it is the importer's resposibility to ensure that it must contain meaningful information about a vulnerability. AffectedPackage diff --git a/docs/source/tutorial_add_new_improver.rst b/docs/source/tutorial_add_new_improver.rst index 04fd819b9..72f80bbc6 100644 --- a/docs/source/tutorial_add_new_improver.rst +++ b/docs/source/tutorial_add_new_improver.rst @@ -34,7 +34,7 @@ Importer Importers are responsible for scraping vulnerability data from various data sources without creating a complete relational model between vulnerabilites, their fixes and store them in a structured fashion. These data are stored in the ``Advisory`` model and can be converted to an equivalent -``AdvioryData`` for various use cases. +``AdvisoryData`` for various use cases. See :ref:`importer-overview` for a brief overview on importers. Importer Prerequisites