Add initial documentation for Runs #2943
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tekton-robot
added
the
release-note
tekton-robot
added
the
size/L
|
/kind documentation |
tekton-robot
added
the
kind/documentation
dlorenc
reviewed
Jul 20, 2020
bobcatfish
reviewed
Jul 20, 2020
There was a problem hiding this comment.
Thanks for adding these @imjasonh ! Generally looks good, my 2 main asks:
- can we link to it from somewhere? e.g. from the docs/README and/or from the pipelines doc (we could put a placeholder in for where we'll add more on custom tasks)
- did we merge any PRs yet that actually make the Runs DO something? (i'm not sure) - if not, could we make it clear that the Run type doesn't yet do anything (in the situation where we do a release tomorrow for example, we'd want the docs to reflect the fact that the type exists but doesnt yet do anything - unless it does in which case ignore me!)
bobcatfish
reviewed
Jul 20, 2020
vdemeester
reviewed
Jul 21, 2020
This is still incomplete as more fields and features will be added to the Run type. This doc should also probably explain the responsibilities of a custom task controller.
|
hey all! we just did a release with this functionality in it and no docs 😬 /lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bobcatfish 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is still incomplete as more fields and features will be added to
the Run type. This doc should also probably explain the responsibilities
of a custom task controller.
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.
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.
Release Notes
/assign @bobcatfish