Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/vuln: improve documentation #69519

Open
zpavlinovic opened this issue Sep 18, 2024 · 1 comment
Open

x/vuln: improve documentation #69519

zpavlinovic opened this issue Sep 18, 2024 · 1 comment
Assignees
Labels
Documentation vulncheck or vulndb Issues for the x/vuln or x/vulndb repo

Comments

@zpavlinovic
Copy link
Contributor

zpavlinovic commented Sep 18, 2024

We should improve documentation on govulncheck:

  • make it clear what are the main benefits of govulncheck, i.e., why should people use it
  • explain how and why govulncheck can generate false positives and how to deal with them
  • explain streaming JSON and OpenVex output as means of govulncheck integrations
  • if applicable: how to filter vulnerabilities
@zpavlinovic zpavlinovic added the vulncheck or vulndb Issues for the x/vuln or x/vulndb repo label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation vulncheck or vulndb Issues for the x/vuln or x/vulndb repo
Projects
None yet
Development

No branches or pull requests

3 participants