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

Add term definitions in the scope of ReferrerStore and Verifier #135

Open
1 task
binbin-li opened this issue May 30, 2023 · 0 comments
Open
1 task

Add term definitions in the scope of ReferrerStore and Verifier #135

binbin-li opened this issue May 30, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@binbin-li
Copy link
Collaborator

What would you like to be added?

Current Oras Store might throw some errors wrapping up errors from Oras-go library, which requires knowledge on the OCI spec. However, beginners might not have enough context on those errors, especially the teminologies in the error message. We probably need to have a section in Store doc to define those common terms. We could just copy definitions from OCI spec, but it's better to provide some examples to help beginner understand it.

Terms might need to be defined:

  • Blob
  • Manifest
  • Image
  • Artifact
  • Descriptor
  • Digest
  • Tag
  • Subject
  • Reference
  • Referrers

The same thing applies to Verifier as well.

  • Certificate
  • Certificate chain
  • Root/leaf/intermediate certificate
  • Signature

Feel free to add more terms.

Anything else you would like to add?

No response

Are you willing to submit PRs to contribute to this feature?

  • Yes, I am willing to implement it.
@binbin-li binbin-li added documentation Improvements or additions to documentation enhancement New feature or request labels May 30, 2023
@susanshi susanshi transferred this issue from ratify-project/ratify Jan 9, 2025
@susanshi susanshi added this to the v1.4.0 milestone Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants