Rewrite the Pipelines tutorial for clarity and flow. #2068
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
Improves the clarity and flow of the Tekton Pipelines tutorial.
tekton-robot
added
the
size/L
googlebot
added
the
cla: yes
Co-Authored-By: Daniel Helfand <[email protected]>
Removes "to the build" since it doesn't make sense.
Replaces `Task` with `TaskRun` where we were referring to `TaskRun` and fixes some incorrect articles.
Shorter and clearer.
|
/retest
…On Tue, Feb 18, 2020 at 3:53 PM Serge Pomorski ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/tutorial.md
<#2068 (comment)>:
>
-[`PipelineResources`](resources.md) are used to define the artifacts that can be
-passed in and out of a `Task`. There are a few system defined resource types ready
-to use, and the following are two examples of the resources commonly needed.
+Use one or more [`PipelineResources`](resources.md) to define the artifacts you'd like to pass in
In this particular case, the two sentences convey the same exact technical
information. The only difference is the passive vs. active voice: "X are
used to do Y" vs "use X to do Y". I think the double passive ("X are used
to define artifacts to be passed") voice is harder to parse, IMHO.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#2068?email_source=notifications&email_token=AG3UR4X2CA65VIHV5M7E7RDRDRDFFA5CNFSM4KXKP7X2YY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCV7U2TQ#discussion_r380928465>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AG3UR4VVVEC2AWQG265UD5TRDRDFFANCNFSM4KXKP7XQ>
.
|
|
Oops, Mistakenly closed. We should merge this! |
Applies danielhelfand's wording fix. Co-Authored-By: Daniel Helfand <[email protected]>
Apply danielhelfand's formatting fix. Co-Authored-By: Daniel Helfand <[email protected]>
Apply danielhelfand's wording fix. Co-Authored-By: Daniel Helfand <[email protected]>
Apply danielhelfand's formatting fix. Co-Authored-By: Daniel Helfand <[email protected]>
Apply danielhelfand's wording fix. Co-Authored-By: Daniel Helfand <[email protected]>
Apply danielhelfand's wording fix. Co-Authored-By: Daniel Helfand <[email protected]>
Addresses all remaining review comments.
|
/approve |
|
In response to this:
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. |
|
[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
nkakkar81
reviewed
Mar 11, 2020
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.
Improves the clarity and flow of the Tekton Pipelines tutorial.