Open
Conversation
Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Security & Best Practices metric documentation to better explain how Insights produces security-related results, adding an explicit Controls Assessment section and a new Vulnerabilities section describing dependency vulnerability scanning, metrics, charts, and remediation guidance.
Changes:
- Added documentation describing how control assessments are sourced (OpenSSF Baseline) and what repositories are included/excluded.
- Added end-user documentation for dependency vulnerability scanning (OSV-Scanner), including supported ecosystems, surfaced metrics, charts, and remediation steps.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Metric | Description | | ||
| |---|---| | ||
| | **Open Vulnerabilities** | Total count of unresolved vulnerabilities across all scanned repositories | | ||
| | **Median CVSS** | Median severity score across all open vulnerabilities, using the CVSS (Common Vulnerability Scoring System) scale | |
There was a problem hiding this comment.
The docs call this metric "Median CVSS", but the backend type returned by the vulnerabilities summary endpoint is avgCvssScore (average). Please align the documentation (and any UI label) with what’s actually computed (median vs average) to avoid misleading users.
Suggested change
| | **Median CVSS** | Median severity score across all open vulnerabilities, using the CVSS (Common Vulnerability Scoring System) scale | | |
| | **Average CVSS** | Average severity score across all open vulnerabilities, using the CVSS (Common Vulnerability Scoring System) scale | |
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.
This pull request enhances the documentation for the Security & Best Practices metrics by adding detailed explanations about the controls assessment process and introducing a comprehensive section on vulnerability scanning and reporting. These updates clarify how security metrics are generated and give users actionable information on interpreting and remediating vulnerabilities.
Additions to security documentation:
Vulnerability reporting and metrics: