Refactor doc to restructure and improve #1943

docs/source/PIPELINES-AVID.rst

@@ -0,0 +1,79 @@
+.. _pipelines_avid:
+
+Pipelines AVID Mapping
+=========================
+
+.. list-table:: Pipeline AVID Mapping
+   :header-rows: 1
+   :widths: 35 65
+
+   * - pipeline name
+     - AVID
+   * - alpine_linux_importer_v2
+     - {package_name}/{distroversion}/{version}/{vulnerability_id}
+   * - aosp_dataset_fix_commits
+     - CVE ID of the record
+   * - apache_httpd_importer_v2
+     - CVE ID of the record
+   * - apache_kafka_importer_v2
+     - CVE ID of the record
+   * - apache_tomcat_importer_v2
+     - {page_id}/{cve_id}
+   * - archlinux_importer_v2
+     - AVG ID of the record
+   * - curl_importer_v2
+     - CURL-CVE ID of the record
+   * - debian_importer_v2
+     - {package_name}/{debian_record_id}
+   * - elixir_security_importer_v2
+     - {package_name}/{file_id}
+   * - epss_importer_v2
+     - CVE ID of the record
+   * - fireeye_importer_v2
+     - {file_id}
+   * - gentoo_importer_v2
+     - GLSA ID of the record
+   * - github_osv_importer_v2
+     - ID of the OSV record
+   * - gitlab_importer_v2
+     - Identifier of the GitLab community advisory record
+   * - istio_importer_v2
+     - ISTIO-SECURITY-<ID>
+   * - mattermost_importer_v2
+     - MMSA-<ID>
+   * - mozilla_importer_v2
+     - MFSA-<ID>
+   * - nginx_importer_v2
+     - First alias of the record
+   * - nodejs_security_wg
+     - NPM-<ID>
+   * - nvd_importer_v2
+     - CVE ID of the record
+   * - openssl_importer_v2
+     - CVE ID of the record
+   * - oss_fuzz_importer_v2
+     - ID of the OSV record
+   * - postgresql_importer_v2
+     - CVE ID of the record
+   * - project-kb-msr-2019_v2
+     - Vulnerability ID of the record
+   * - project-kb-statements_v2
+     - Vulnerability ID of the record
+   * - pypa_importer_v2
+     - {package_name}/{ID of the OSV record}
+   * - pysec_importer_v2
+     - ID of the OSV record
+   * - redhat_importer_v2
+     - RHSA ID of the record
+   * - retiredotnet_importer_v2
+     - retiredotnet-{file_id}
+   * - ruby_importer_v2
+     - {file_id}
+   * - suse_importer_v2
+     - CVE ID of the record
+   * - ubuntu_osv_importer_v2
+     - ID of the OSV record
+   * - vulnrichment_importer_v2
+     - CVE ID of the record
+   * - xen_importer_v2
+     - XSA-<ID>

docs/source/SOURCES.rst

@@ -0,0 +1,112 @@
+.. _sources:
+
+Sources
+=======
+
+.. list-table:: Sources
+   :header-rows: 1
+   :widths: 20 50 30
+
+   * - Importer Name
+     - Data Source
+     - Ecosystems Covered
+
+   * - rust
+     - https://github.com/RustSec/advisory-db
+     - rust crates
+
+   * - alpine
+     - https://secdb.alpinelinux.org/
+     - alpine packages
+
+   * - archlinux
+     - https://security.archlinux.org/json
+     - arch packages
+
+   * - debian
+     - https://security-tracker.debian.org/tracker/data/json
+     - debian packages
+
+   * - npm
+     - https://github.com/nodejs/security-wg.git
+     - npm packages
+
+   * - ruby
+     - https://github.com/rubysec/ruby-advisory-db.git
+     - ruby gems
+
+   * - ubuntu
+     -
+     - ubuntu packages
+
+   * - retiredotnet
+     - https://github.com/RetireNet/Packages.git
+     - .NET packages
+
+   * - suse_backports
+     - http://ftp.suse.com/pub/projects/security/yaml/
+     - SUSE packages
+
+   * - debian_oval
+     - https://www.debian.org/security/oval/
+     - debian packages
+
+   * - redhat
+     - https://access.redhat.com/hydra/rest/securitydata/cve.json
+     - rpm packages
+
+   * - nvd
+     - https://nvd.nist.gov/vuln/data-feeds#JSON_FEED
+     - none
+
+   * - gentoo
+     - https://anongit.gentoo.org/git/data/glsa.git
+     - gentoo packages
+
+   * - openssl
+     - https://www.openssl.org/news/vulnerabilities.xml
+     - openssl
+
+   * - ubuntu_usn
+     - https://usn.ubuntu.com/usn-db/database-all.json.bz2
+     - ubuntu packages
+
+   * - github
+     - https://api.github.com/graphql
+     - maven, .NET, php-composer, pypi packages, ruby gems
+
+   * - msr2019
+     - https://raw.githubusercontent.com/SAP/project-kb/master/MSR2019/dataset/vulas_db_msr2019_release.csv
+     - maven packages
+
+   * - apache_httpd
+     - https://httpd.apache.org/security/json
+     - apache-httpd
+
+   * - kaybee
+     - https://github.com/SAP/project-kb.git
+     - maven packages
+
+   * - nginx
+     - http://nginx.org/en/security_advisories.html
+     - nginx
+
+   * - postgresql
+     - https://www.postgresql.org/support/security/
+     - postgresql
+
+   * - elixir_security
+     - https://github.com/dependabot/elixir-security-advisories
+     - hex packages
+
+   * - suse_scores
+     - https://ftp.suse.com/pub/projects/security/yaml/suse-cvss-scores.yaml
+     - vulnerability severity scores by SUSE
+
+   * - mozilla
+     - https://github.com/mozilla/foundation-security-advisories
+     - mozilla
+
+   * - mattermost
+     - https://mattermost.com/security-updates/
+     - mattermost server, desktop and mobile apps