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: add Ratify v2 design scope discussion #1905

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

binbin-li
Copy link
Collaborator

@binbin-li binbin-li commented Oct 30, 2024

Description

What this PR does / why we need it:

Add docs for Ratify v2 design scope discussion

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #1885

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

Copy link

codecov bot commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

see 4 files with indirect coverage changes

@binbin-li binbin-li force-pushed the ratify-v2 branch 2 times, most recently from 92bea57 to 1fdad75 Compare October 30, 2024 14:44
@binbin-li binbin-li force-pushed the ratify-v2 branch 2 times, most recently from 4cf1588 to dcac297 Compare November 7, 2024 07:54
@susanshi
Copy link
Collaborator

posting notes from community meeting discussion here so we don't lose it:
TODO:

  • reword the first goal with a positive sentiment
  • call out increase test coverage explicitly
  • propose priorities for each solution/improvement
  • link to issues to show customer need

@binbin-li binbin-li force-pushed the ratify-v2 branch 2 times, most recently from fae4235 to 65b2b7f Compare November 18, 2024 14:47
Copy link
Collaborator

@susanshi susanshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for PR binbin. Left some comments, would you also be able to comment around proposed milestone? are we doing alpha , beta, rc then stable?

docs/discussion/Ratify v2 design scope.md Outdated Show resolved Hide resolved
docs/discussion/Ratify v2 design scope.md Outdated Show resolved Hide resolved
@binbin-li
Copy link
Collaborator Author

thanks for PR binbin. Left some comments, would you also be able to comment around proposed milestone? are we doing alpha , beta, rc then stable?

You're right. We'll have alpha, beta, rc to stable for v2 while we working on v1.x. And we can gather feedback and suggestions before stable release.

@susanshi
Copy link
Collaborator

Discussed in PR review meeting , there are some adjust needed to the design from previous conversation. @binbin-li , please tag us again once this is ready for review.

@binbin-li
Copy link
Collaborator Author

@akashsinghal @susanshi @FeynmanZhou I've addressed comments and updated doc, please take another look!

Copy link
Collaborator

@junczhu junczhu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ratify v2 design
5 participants