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 intoto type documentation #679

Merged
merged 3 commits into from
Feb 17, 2022

Conversation

jspeed-meyers
Copy link
Contributor

Summary

This PR proposes some documentation for the intoto pluggable type to help non-expert users understand fields not otherwise documented. I tried to keep this documentation proximate to the code, i.e. in the relevant GitHub section, and largely pointed to relevant specifications, rather than repeating at length information from those specifications. If this type of documentation is useful (and if it's not, no hurt feelings :) ), I'll submit similar documentation for other pluggable types as appropriate.

Related topic potentially better handled in separate issues and PRs:

  • @nsmith5 pointed out that the rekor API returns a different format than the rekor-cli. This makes writing documentation harder. I did not address this aspect in the documentation I wrote. I figured that is a larger and separate topic.

Interested parties: @bobcallaway, @vaikas, @dlorenc, @SantiagoTorres, @znewman01

Ticket Link

Related to issue #665.

Release Note

NONE

Signed-off-by: John Speed Meyers <jsmeyers@chainguard.dev>
Signed-off-by: John Speed Meyers <jsmeyers@chainguard.dev>
Signed-off-by: John Speed Meyers <jsmeyers@chainguard.dev>
@jspeed-meyers jspeed-meyers force-pushed the add-intoto-type-documentation branch from c06c358 to 3eeb788 Compare February 17, 2022 14:49
@jspeed-meyers jspeed-meyers requested a review from a team as a code owner February 17, 2022 14:49
@jspeed-meyers
Copy link
Contributor Author

Sorry if I dorked this PR up while doing the DCO. Let me know and I will resubmit.

@jspeed-meyers jspeed-meyers force-pushed the add-intoto-type-documentation branch from 3eeb788 to 1122406 Compare February 17, 2022 15:15
@lukehinds lukehinds merged commit f314ee9 into sigstore:main Feb 17, 2022
@github-actions github-actions bot added this to the v1.0.0 milestone Feb 17, 2022
@jspeed-meyers jspeed-meyers deleted the add-intoto-type-documentation branch March 1, 2022 16:28
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