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.
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?
|
|
||
| ## Features | ||
|
|
||
| - Includes both [Maven](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin) and [Gradle](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle) build plugins |
There was a problem hiding this comment.
| - Includes both [Maven](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin) and [Gradle](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle) build plugins | |
| - [Maven](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin) and [Gradle](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle) signing plugins |
| - Keyless signing and verifying | ||
| - [API](https://javadoc.io/doc/dev.sigstore/sigstore-java) |
There was a problem hiding this comment.
| - Keyless signing and verifying | |
| - [API](https://javadoc.io/doc/dev.sigstore/sigstore-java) | |
| - Java native signing and verifying [API](https://javadoc.io/doc/dev.sigstore/sigstore-java) |
|
|
||
| More information on the Gradle build plugin is available in the [project repository](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle#sigstore-gradle). | ||
|
|
||
| ## Example |
There was a problem hiding this comment.
| ## Example | |
| ## API Usage Examples |
|
|
||
| ## Example | ||
|
|
||
| ### Signing example |
There was a problem hiding this comment.
| ### Signing example | |
| ### Signing |
| String bundleJson = result.toJson(); | ||
| ``` | ||
|
|
||
| ### Verifying example |
There was a problem hiding this comment.
| ### Verifying example | |
| ### Verifying |
Summary
Partially addresses #324 by adding Java client information.
Release Note
None