Skip to content

Improve the document for new users to understand quickly that Cosign supports blobs signing #2554

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.

Sign up for GitHub

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

Jump to bottom
Closed
suzuki-shunsuke opened this issue Dec 18, 2022 · 2 comments · Fixed by #2566
Closed

Improve the document for new users to understand quickly that Cosign supports blobs signing #2554

suzuki-shunsuke opened this issue Dec 18, 2022 · 2 comments · Fixed by #2566
Assignees
@znewman01
Labels
documentation Improvements or additions to documentation

Comments

@suzuki-shunsuke
Copy link

Thank you for your great project.
I have a feedback about the document about Cosign.

Cosign supports not only containers but also standard files and blobs (or binary large objects).

https://docs.sigstore.dev/cosign/working_with_blobs

But I misunderstood Cosign supports only containers, because the repository description and the top of README and official document describe only containers.

repository description

Container Signing

README

Container Signing, Verification and Storage in an OCI registry.

Official document: https://docs.sigstore.dev/cosign/overview

Cosign supports container signing, verification, and storage in an OCI registry.

I know there is a document about blobs signing, but users may miss the document.

So I think we should improve the document so that new users can understand quickly that Cosign supports blobs signing.

What do you think?
@suzuki-shunsuke suzuki-shunsuke added the enhancement New feature or request label Dec 18, 2022
@suzuki-shunsuke
Copy link
Author

Oh, the issue label is inappropriate.
Could you remove the enhancement label and add the documentation label?

@dlorenc dlorenc added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Dec 18, 2022
@dlorenc
Copy link
Member

dlorenc commented Dec 18, 2022

All set!

@znewman01 znewman01 self-assigned this Dec 21, 2022
znewman01 added a commit to znewman01/cosign that referenced this issue Dec 21, 2022
@znewman01
Update docs to clarify that Cosign isn't only OCI
ddd0172 
Fixes sigstore#2554.

Signed-off-by: Zachary Newman <zjn@chainguard.dev>
@znewman01 znewman01 mentioned this issue Dec 21, 2022
Merged
znewman01 added a commit that referenced this issue Dec 21, 2022
@znewman01
Update docs to clarify that Cosign isn't only OCI (#2566)
64806ca 
Fixes #2554.

Signed-off-by: Zachary Newman <zjn@chainguard.dev>

Signed-off-by: Zachary Newman <zjn@chainguard.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@znewman01 znewman01

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update docs to clarify that Cosign isn't only OCI znewman01/cosign
3 participants
@znewman01 @dlorenc @suzuki-shunsuke