Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Interested parties: @bobcallaway, @vaikas, @dlorenc, @SantiagoTorres, @znewman01
Ticket Link
Related to issue #665.
Release Note