Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference to Task authoring recommendations #4318

Merged
merged 1 commit into from
Oct 15, 2021

Conversation

jerop
Copy link
Member

@jerop jerop commented Oct 15, 2021

Changes

We have Task authoring recommendations in the Tekton Catalog.

As described in #3948, users
need these recommendations but they are not easily discoverable.

Therefore, adding a reference to these recommendations in Tasks
documentation to make it more discoverable.

Closes #3948

/kind documentation

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Docs included if any changes are user facing
  • [n/a] Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Release notes block below has been filled in or deleted (only if no user facing changes)

Release Notes

NONE

cc @pittar

We have `Task` authoring recommendations in the [Tekton Catalog][recommendations].

As described in tektoncd#3948, users
need these recommendations but they are not easily discoverable.

Therefore, adding a reference to these recommendations in `Tasks`
documentation to make it more discoverable.

Closes tektoncd#3948

[recommendations]: https://github.com/tektoncd/catalog/blob/main/recommendations.md
@tekton-robot tekton-robot added kind/documentation Categorizes issue or PR as related to documentation. release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Oct 15, 2021
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 15, 2021
@ghost
Copy link

ghost commented Oct 15, 2021

Cheers!

/lgtm

@tekton-robot tekton-robot assigned ghost Oct 15, 2021
@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 15, 2021
@pritidesai
Copy link
Member

@jerop
Copy link
Member Author

jerop commented Oct 15, 2021

What do you think about including some treasure from @GregDritschler: 😄

@pritidesai that issue was not really about custom tasks as we know it, they were referring to vanilla tasks that are written by a user

seems to be a common confusion - saw it here too: https://cd.foundation/blog/2021/04/22/cloud-native-ci-cd-with-tekton-building-custom-tasks/

but those would be useful resources that we should add when we expand the actual custom tasks documentation

@pritidesai
Copy link
Member

sounds good, thanks @jerop

/approve

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pritidesai

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 15, 2021
@tekton-robot tekton-robot merged commit 918ca4f into tektoncd:main Oct 15, 2021
@jerop jerop deleted the authoring-recs branch June 11, 2022 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs or Blog Post for Creating Custom Tasks
3 participants