Improve TaskRun workspaces documentation #2632
Conversation
tekton-robot
added
the
kind/documentation
tekton-robot
added
the
size/M
|
Hi @jlpettersson. Thanks for your PR. I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
tekton-robot
added
the
needs-ok-to-test
|
This PR cannot be merged: expecting exactly one kind/ label Available
|
This was unexpected. The PR had a kind-label, but with the syntax slash-kind, and that is the syntax used in other PRs. And the "Info"-section describes other label-syntax than is used in other PRs
This check is green
And the tekton-robot correctly added a label. |
This commit contains similar changes for the TaskRun section as what was done for the PipelineRun section in tektoncd#2521 - We did not provide a full example of a TaskRun definition under "Examples of `TaskRun` definition using `Workspaces`" This commit add a full example of a TaskRun definition. - Examples of how to use different volume sources already exists under "Specifying `VolumeSources` in `Workspaces`", add a link to that section instead of having the same examples under the TaskRun section. - A few broken links in the table-of-contents are fixed. /kind documentation
jlpettersson
force-pushed
the
improve_taskrun_workspaces_doc
branch
from
235b829 to
cb3ec93
Compare
|
/ok-to-test |
tekton-robot
added
ok-to-test
|
/cc @sbwsg |
The check for the label is run on the "sync", "pull_request" and add/remove label events. When the events are processed the PR does not yet have a label, so it posts the comment and sets the check to not-passed. In parallel the "kind" bot adds the label, triggers the check again, and sets the check to passed. We don't have a mechanism in place to delete the old comment once that happens. That would require us to have a memory of what the comment was, or perhaps add some invisible metadata into the comment, so we can delete it. Would you mind filing an issue on plumbing for this? |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sbwsg The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
|
/lgtm |
Jonas has recently become a regularly contributor. He started with adding a minor [_missing_ `omitempty`](tektoncd/pipeline#2301) and then [proposed some ideas](tektoncd/pipeline#1986 (comment)) around workspaces and PersistentVolumeClaim creation and continued to [elaborate around those ideas](tektoncd/pipeline#1986 (comment)). A sunny day a few days later, he also submitted an [extensive implementation for volumeClaimTemplate](tektoncd/pipeline#2326), corresponding to the idea discussions. A few days later submitted a [small refactoring PR](tektoncd/pipeline#2392), and he also listened to community members that [proposed changes](tektoncd/pipeline#2450) to his implementation about volumeClaimTemplates and did an [implementation for that proposal](tektoncd/pipeline#2453). A rainy day, he also wrote [technical documentation about PVCs](tektoncd/pipeline#2521) including adding an example that caused _flaky_ integration tests for the whole community during multiple days. When he understood his mistake, he submitted a [removal of the example](tektoncd/pipeline#2546) that caused flaky tests. He has also put his toe into Tekton Catalog and [contributed to the buildah task](tektoncd/pipeline#2546). This has followed, mostly with more PRs to the Pipeline project: - tektoncd/pipeline#2460 - tektoncd/pipeline#2491 - tektoncd/pipeline#2502 - tektoncd/pipeline#2506 - tektoncd/pipeline#2632 - tektoncd/pipeline#2633 - tektoncd/pipeline#2634 - tektoncd/pipeline#2636 - tektoncd/pipeline#2601 - tektoncd/pipeline#2630 Jonas is excited about the great community around Tekton and the project! He now would like to join the org.
Jonas has recently become a regularly contributor. He started with adding a minor [_missing_ `omitempty`](tektoncd/pipeline#2301) and then [proposed some ideas](tektoncd/pipeline#1986 (comment)) around workspaces and PersistentVolumeClaim creation and continued to [elaborate around those ideas](tektoncd/pipeline#1986 (comment)). A sunny day a few days later, he also submitted an [extensive implementation for volumeClaimTemplate](tektoncd/pipeline#2326), corresponding to the idea discussions. A few days later submitted a [small refactoring PR](tektoncd/pipeline#2392), and he also listened to community members that [proposed changes](tektoncd/pipeline#2450) to his implementation about volumeClaimTemplates and did an [implementation for that proposal](tektoncd/pipeline#2453). A rainy day, he also wrote [technical documentation about PVCs](tektoncd/pipeline#2521) including adding an example that caused _flaky_ integration tests for the whole community during multiple days. When he understood his mistake, he submitted a [removal of the example](tektoncd/pipeline#2546) that caused flaky tests. He has also put his toe into Tekton Catalog and [contributed to the buildah task](tektoncd/pipeline#2546). This has followed, mostly with more PRs to the Pipeline project: - tektoncd/pipeline#2460 - tektoncd/pipeline#2491 - tektoncd/pipeline#2502 - tektoncd/pipeline#2506 - tektoncd/pipeline#2632 - tektoncd/pipeline#2633 - tektoncd/pipeline#2634 - tektoncd/pipeline#2636 - tektoncd/pipeline#2601 - tektoncd/pipeline#2630 Jonas is excited about the great community around Tekton and the project! He now would like to join the org.
Changes
This commit contains similar changes for the TaskRun section as what was done for the PipelineRun section in #2521
We did not provide a full example of a TaskRun definition under "Examples of
TaskRundefinition usingWorkspaces". This commit add a full example of a TaskRun definition.Examples of how to use different volume sources already exists under "Specifying
VolumeSourcesinWorkspaces", add a link to that section instead of having the same examples under the TaskRun section.A few broken links in the table-of-contents are fixed.
/kind documentation
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmddir, please updatethe release Task to build and release this image.
Reviewer Notes
If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.