Include PipelineRun in diagrams
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 277
- Forks
- 164
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 61
Description
Feature request
The following diagrams are great:
https://github.com/tektoncd/chains/blob/main/docs/tutorials/images/getting_started.png
https://github.com/tektoncd/chains/blob/main/docs/tutorials/images/signed_provenance.png
But they exclude the PipelineRun SLSA Provenance that Chains generates. Let's update those diagrams as well as the corresponding tutorials to highlight that Chains observes both TaskRuns and PipelineRuns.
Use case
Not mentioning how Chains interacts with PipelineRuns is confusing to users.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/tutorials/images/getting_started.png and docs/tutorials/images/signed_provenance.png, then read the corresponding tutorials. Update both diagrams and tutorials to show that Chains observes TaskRuns and PipelineRuns, including PipelineRun SLSA Provenance. Done means the diagrams and tutorial text consistently explain both resource types.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100