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

docs: update design/tradeoffs doc regarding scanner vuln reports #818 #854

Open
wants to merge 87 commits into
base: main
Choose a base branch
from

Conversation

pradhans0906
Copy link
Contributor

Description

Updates the tradeoffs section in the design documentation to accurately reflect copa's ability to work with or without vulnerability scanner reports.

The changes:

  • Remove outdated statements about scanner report dependencies
  • Clarify the package-based update model
  • Maintain information about package manager dependencies and platform limitations
  • Improve document structure for better readability

Changes

  • Replace outdated tradeoffs content with updated, accurate information
  • Add clearer section organization with numbered points
  • Update description of scanner integration to reflect optional usage

Closes #818

@ashnamehrotra ashnamehrotra changed the title [DOC] update design/tradeoffs doc regarding scanner vuln reports #818 docs: update design/tradeoffs doc regarding scanner vuln reports #818 Dec 5, 2024
website/docs/design.md Outdated Show resolved Hide resolved
website/docs/design.md Outdated Show resolved Hide resolved
@ashnamehrotra
Copy link
Contributor

ashnamehrotra commented Dec 6, 2024

@pradhans0906 can we also add these changes to version docs starting from v0.7.0, since that was the release of the update all feature. DCO also needs to be fixed to sign-off commits.

website/docs/design.md Outdated Show resolved Hide resolved
@ashnamehrotra
Copy link
Contributor

@pradhans0906 thank you! looks like the commits need sign off again for DCO check

pradhans0906 and others added 5 commits December 14, 2024 18:47
Prequisitives > Prerequisites

Signed-off-by: swapnasagar pradhan <[email protected]>
…ic#821)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Signed-off-by: Sertaç Özercan <[email protected]>
Co-authored-by: Ashna Mehrotra <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
dependabot bot and others added 13 commits December 14, 2024 19:21
…ect-copacetic#822)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#827)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertaç Özercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…ic#835)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#833)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertaç Özercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…acetic#832)

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertac Ozercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…opacetic#824)

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertac Ozercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
)

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertac Ozercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#838)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertaç Özercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…ect-copacetic#840)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…cetic#841)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#843)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
dependabot bot and others added 29 commits December 14, 2024 19:23
…ic#835)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#833)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertaç Özercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…acetic#832)

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertac Ozercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…opacetic#824)

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertac Ozercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
)

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Sertac Ozercan <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertac Ozercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#838)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertaç Özercan <[email protected]>
…ect-copacetic#840)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…cetic#841)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#843)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…ic#846)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…opacetic#847)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…-copacetic#848)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…tic#849)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…opacetic#852)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…ic#859)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…opacetic#860)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…#861)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…acetic#864)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
….4.0+incompatible (project-copacetic#865)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…tic#870)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…#871)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…ic#821)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…ect-copacetic#822)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#838)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sertaç Özercan <[email protected]>
Signed-off-by: swapnasagar pradhan <[email protected]>
…copacetic#843)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: swapnasagar pradhan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

Successfully merging this pull request may close these issues.

[DOC] update design/tradeoffs doc regarding scanner vuln reports
4 participants