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

Java client information. #346

Merged
merged 7 commits into from
Nov 19, 2024
Merged

Java client information. #346

merged 7 commits into from
Nov 19, 2024

Conversation

hayleycd
Copy link
Contributor

@hayleycd hayleycd commented Nov 6, 2024

Summary

Partially addresses #324 by adding Java client information.

Release Note

None

Signed-off-by: hayleycd <cook.hayley@gmail.com>
Copy link

netlify bot commented Nov 6, 2024

Deploy Preview for docssigstore ready!

Name Link
🔨 Latest commit cf9df62
🔍 Latest deploy log https://app.netlify.com/sites/docssigstore/deploys/673bec296221ad00083bcd17
😎 Deploy Preview https://deploy-preview-346--docssigstore.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: hayleycd <cook.hayley@gmail.com>
@hayleycd
Copy link
Contributor Author

hayleycd commented Nov 6, 2024

@loosebazooka tagging you in case you want to review. CC: @haydentherapper @cmurphy

@loosebazooka
Copy link
Member

loosebazooka commented Nov 7, 2024

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.

@hayleycd
Copy link
Contributor Author

hayleycd commented Nov 7, 2024

@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.

@haydentherapper
Copy link
Contributor

@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 <cook.hayley@gmail.com>
Signed-off-by: hayleycd <cook.hayley@gmail.com>
Signed-off-by: hayleycd <cook.hayley@gmail.com>
@hayleycd
Copy link
Contributor Author

hayleycd commented Nov 8, 2024

Thanks for the comments @haydentherapper I have addressed them and merged main.

haydentherapper
haydentherapper previously approved these changes Nov 8, 2024
Copy link
Contributor

@haydentherapper haydentherapper left a 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?

Copy link
Member

@loosebazooka loosebazooka left a 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.

content/en/language_clients/java/overview.md Outdated Show resolved Hide resolved
content/en/language_clients/java/overview.md Outdated Show resolved Hide resolved
content/en/language_clients/java/overview.md Outdated Show resolved Hide resolved
content/en/language_clients/java/overview.md Outdated Show resolved Hide resolved
content/en/language_clients/java/overview.md Outdated Show resolved Hide resolved
Signed-off-by: hayleycd <cook.hayley@gmail.com>
Signed-off-by: hayleycd <cook.hayley@gmail.com>
@haydentherapper haydentherapper merged commit 5e694d5 into sigstore:main Nov 19, 2024
6 checks passed
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.

3 participants