Add vuln data source docs and initial air-gap guide#97
Merged
Conversation
Signed-off-by: nscuro <nscuro@protonmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the documentation around vulnerability data sources by replacing per-datasource reference pages with a consolidated “concepts” explainer and an administration how-to, and adds an initial guide for operating Dependency-Track in air-gapped environments.
Changes:
- Add new conceptual and procedural docs for vulnerability data sources and how to enable/schedule mirroring.
- Add an initial “Running air-gapped” administration guide and wire it into existing docs.
- Remove legacy per-source reference pages (NVD/GitHub advisories/OSV) and update navigation and cross-links accordingly.
Reviewed changes
Copilot reviewed 18 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/index.md | Updates reference landing page to point to the new concept + admin guide and the consolidated datasources overview. |
| docs/reference/datasources/private-vulnerability-repository.md | Reflows/modernizes wording and headings for consistency and readability. |
| docs/reference/datasources/osv.md | Removes legacy OSV per-source reference page in favor of consolidated docs. |
| docs/reference/datasources/nvd.md | Removes legacy NVD per-source reference page in favor of consolidated docs. |
| docs/reference/datasources/internal-components.md | Rewords/normalizes the internal components datasource reference page. |
| docs/reference/datasources/index.md | Refocuses the datasources overview page and links out to the new concept/admin procedure docs. |
| docs/reference/datasources/github-advisories.md | Removes legacy GitHub advisories per-source reference page in favor of consolidated docs. |
| docs/reference/datasources/.pages | Updates datasources navigation to remove the deleted per-source pages. |
| docs/reference/analyzers.md | Adds a pointer from the internal analyzer reference to the new vulnerability data sources concept page. |
| docs/guides/administration/running-air-gapped.md | Adds a new (explicitly incomplete) air-gapped operation guide for sources/analyzers. |
| docs/guides/administration/migrating-from-v4.md | Adds a link to the new vulnerability sources configuration procedure post-migration. |
| docs/guides/administration/configuring-vulnerability-sources.md | Adds a new step-by-step guide for enabling and mirroring NVD/GitHub/OSV. |
| docs/guides/administration/configuring-internal-ca.md | Clarifies internal CA trust scenarios for internal mirrors and links to new docs. |
| docs/guides/administration/configuring-http-proxy.md | Links proxy guidance directly to vulnerability data source configuration. |
| docs/guides/administration/.pages | Adds the two new administration guide pages to navigation. |
| docs/concepts/changes-in-v5.md | Links v5 changes doc to the new air-gapped guide for internal mirror hosting. |
| docs/concepts/about-vulnerability-data-sources.md | Adds a new concept page explaining what each source provides and matching trade-offs. |
| docs/concepts/.pages | Adds the new concept page to the Concepts navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Niklas <nscuro@protonmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Niklas <nscuro@protonmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.