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 roadmap #1344

Merged
merged 9 commits into from
Apr 9, 2024
Merged

docs: add roadmap #1344

merged 9 commits into from
Apr 9, 2024

Conversation

yizha1
Copy link
Collaborator

@yizha1 yizha1 commented Mar 20, 2024

Description

What this PR does / why we need it:

Add roadmap which is missing in Ratify project.

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):

This PR implemented one of the work items listed in issue #1334 for roadmap.

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 Mar 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (staging@c1ba70e). Click here to learn what that means.

Additional details and impacted files
@@            Coverage Diff             @@
##             staging    #1344   +/-   ##
==========================================
  Coverage           ?   65.14%           
==========================================
  Files              ?      104           
  Lines              ?     5440           
  Branches           ?        0           
==========================================
  Hits               ?     3544           
  Misses             ?     1538           
  Partials           ?      358           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yizha1 yizha1 requested a review from sajayantony March 20, 2024 09:38
@yizha1 yizha1 changed the title doc: add roadmap docs: add roadmap Mar 20, 2024
ROADMAP.md Show resolved Hide resolved
@sajayantony
Copy link
Contributor

Can you link to some existing roadmaps which we can use as reference to review this?

@yizha1
Copy link
Collaborator Author

yizha1 commented Mar 26, 2024

Can you link to some existing roadmaps which we can use as reference to review this?

Thanks @sajayantony

Here are some references from popular communities, which I checked while creating Ratify's roadmap. Not all the CNCF projects have the ROADMAP.md in their repository. Currently Ratify's roadmap is following the structure: First, the mission of Ratify project, then the strategy for the mission, and the roadmap in detailed steps and timeline from execution point of view.

Please let me know if any further comments.

ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Show resolved Hide resolved
akashsinghal
akashsinghal previously approved these changes Apr 1, 2024
Copy link
Collaborator

@akashsinghal akashsinghal 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 adding the roadmap. I would recommend @binbin-li @luisdlp @susanshi approve as well before merging.

Signed-off-by: Yi Zha (from Dev Box) <[email protected]>
ROADMAP.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM. I think it's ready for the first version and we could continuously update it by milestone.

@luisdlp
Copy link
Collaborator

luisdlp commented Apr 8, 2024

Its a good first draft, some deliverable dates seem to aggressive or need to be scoped down.

luisdlp
luisdlp previously approved these changes Apr 8, 2024
**Major features**

- Attestations support
- Use Ratify at container runtime (Preview)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not likely happening by September.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks @luisdlp. We can update this file in next iteration.

@luisdlp luisdlp changed the base branch from main to staging April 9, 2024 00:04
@luisdlp luisdlp dismissed their stale review April 9, 2024 00:04

The base branch was changed.

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.

LGTM. thanks

@susanshi susanshi merged commit 2ddd204 into ratify-project:staging Apr 9, 2024
13 checks passed
binbin-li pushed a commit that referenced this pull request Apr 9, 2024
Signed-off-by: Yi Zha (from Dev Box) <[email protected]>
binbin-li pushed a commit to binbin-li/ratify that referenced this pull request Apr 10, 2024
Signed-off-by: Yi Zha (from Dev Box) <[email protected]>
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.

6 participants