From 5af079af154c8bc8fa9a17bc9b0478ac44c82288 Mon Sep 17 00:00:00 2001 From: Andrew Pollock Date: Wed, 31 Jul 2024 13:53:50 +1000 Subject: [PATCH] Tighten up the initial FAQ entry (#2429) I'd like to link to this in outreach emails, and make it more self-contained as the initial introduction to OSV. --- docs/faq.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 5f6c0baa534..0bada1091d4 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -21,8 +21,14 @@ nav_order: 4 OSV consists of: -1. [The OSV Schema](https://ossf.github.io/osv-schema/): An easy-to-use data format that maps precisely to open source versioning schemes. -2. Reference infrastructure (this site, API, and tooling) that aggregates and indexes vulnerability data from databases that use the OSV schema. +1. [The OSV Schema](https://ossf.github.io/osv-schema/): An easy-to-use data + format that maps precisely to open source versioning schemes. +2. Reference infrastructure ([OSV.dev website](https://osv.dev/), + [API](../api/), and tooling) that aggregates, + [enriches](#what-does-osvdev-do-to-the-records-it-imports) and indexes + vulnerability data from databases that use the OSV schema. +3. [OSV-Scanner](https://github.com/google/osv-scanner), the officially + supported frontend for OSV.dev We created OSV to address many of the shortcomings of dealing with vulnerabilities in open source software using existing solutions.