-
Notifications
You must be signed in to change notification settings - Fork 81
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
Java client information. #346
Conversation
Signed-off-by: hayleycd <[email protected]>
✅ Deploy Preview for docssigstore ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: hayleycd <[email protected]>
@loosebazooka tagging you in case you want to review. CC: @haydentherapper @cmurphy |
I'm not sure how I feel about the duplication of information... These tend to go out of date as the source of truth would be sigstore-java? Should this just be an automated pull in of the readme on sigstore-java (or some translation of it)? Alternatively we could include this is a point to update in our release plan, but that does put more work on the devs. |
@loosebazooka that makes a lot of sense. @haydentherapper @cmurphy and I are trying to thread a needle a little bit--a little bit of repetition, but increased exposure, and the devs get to primarily work within their own repositories and aren't forced to standardize between the different language clients. We have open PRs for the other language clients too. |
@loosebazooka We've tried to find a balance. We want to highlight all clients in the documentation, while leaving deeper technical documentation in the client repo and a responsibility of the package maintainer to keep it up to date. We tried to create a "quickstart" for each client and with documentation that is unlikely to frequently go out of date. Do you have any suggestions on what we should omit? |
Signed-off-by: hayleycd <[email protected]>
Signed-off-by: hayleycd <[email protected]>
Signed-off-by: hayleycd <[email protected]>
Thanks for the comments @haydentherapper I have addressed them and merged main. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving from my perspective. I'll wait for @loosebazooka to review again. One compromise could be to remove the examples from the docs and point to examples in the repository?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some minor things. I think for most users the gradle and maven plugins are the main entry points. The sigstore-java api is available, but I don't see that as the primary source of adoption.
Signed-off-by: hayleycd <[email protected]>
Signed-off-by: hayleycd <[email protected]>
Summary
Partially addresses #324 by adding Java client information.
Release Note
None