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.

Sign up for GitHub

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

Jump to bottom

Fix inaccurate docs about TriggerTemplate #477

Merged
merged 1 commit into from
Mar 12, 2020
Merged

Fix inaccurate docs about TriggerTemplate #477

merged 1 commit into from
Mar 12, 2020

Conversation

ncskier
Copy link
Member

@ncskier ncskier commented Mar 12, 2020 •
edited
Loading

Changes

  • Fix inaccurate main README which said

    TriggerTemplates can create any Kubernetes resource.

  • Make it more visible that TriggerTemplates can only create Tekton resources.

Issue #476 was raised because our docs have inaccurate information about what K8s resources TriggerTemplates can create.

/cc @disposab1e
/cc @dibyom

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.

@tekton-robot tekton-robot requested a review from dibyom March 12, 2020 17:40
@tekton-robot
Copy link

@ncskier: GitHub didn't allow me to request PR reviews from the following users: disposab1e.

Note that only tektoncd members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Changes

Make it more visible that TriggerTemplates can only create Tekton resources.

Issue #476 was raised because our docs did not properly highlight that TriggerTemplates can only create Tekton resources at the moment.

/cc @disposab1e
/cc @dibyom

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.

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 tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 12, 2020
@ncskier ncskier mentioned this pull request Mar 12, 2020
Closed
@ncskier
Copy link
Member Author

ncskier commented Mar 12, 2020

/test pull-tekton-triggers-build-tests

@disposab1e
Copy link

Perhaps you mights change in the /README.md too?

Using tektoncd/triggers in conjunction with tektoncd/pipeline enables you to easily create full-fledged CI/CD systems where the execution is defined entirely through Kubernetes resources. This repo draws inspiration from Tekton, but can used stand alone since TriggerTemplates can create any Kubernetes resource.

@ncskier
Copy link
Member Author

ncskier commented Mar 12, 2020 •
edited
Loading

This repo draws inspiration from Tekton, but can used stand alone since TriggerTemplates can create any Kubernetes resource.

Thanks @disposab1e, the README was not adequately updated when Triggers disallowed the creation of any K8s resource 🤦‍♂

I just updated my PR to fix this.

Fix inaccurate docs about TriggerTemplate
304923c 
- Fix inaccurate main README which said "TriggerTemplates can create any
Kubernetes resource."
- Make it more visible that TriggerTemplates can only create Tekton resources.
@ncskier ncskier changed the title Improve TriggerTemplate docs Fix inaccurate docs about TriggerTemplate Mar 12, 2020
@ncskier
Copy link
Member Author

ncskier commented Mar 12, 2020

/test pull-tekton-triggers-build-tests

1 similar comment
@ncskier
Copy link
Member Author

ncskier commented Mar 12, 2020

/test pull-tekton-triggers-build-tests

dibyom
dibyom approved these changes Mar 12, 2020
View reviewed changes
Copy link
Member

@dibyom dibyom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 12, 2020
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

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 Mar 12, 2020
@tekton-robot tekton-robot merged commit 0ea7560 into tektoncd:master Mar 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dibyom dibyom dibyom approved these changes

Assignees

@dibyom dibyom

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ncskier @tekton-robot @disposab1e @dibyom @googlebot