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

Write a new Tekton Triggers Overview #972

Merged
merged 1 commit into from
Feb 26, 2021
Merged

Write a new Tekton Triggers Overview #972

merged 1 commit into from
Feb 26, 2021

Conversation

tualeron
Copy link
Contributor

Changes

Write a new Tekton Triggers Overview that explains at a high-level what Triggers is, how it works, and what you can do with it.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Release Notes

NONE

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Feb 25, 2021
@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 25, 2021
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.

Couple of small comments. Otherwise looks great!

docs/README.md Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@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 Feb 25, 2021
Write a new Tekton Triggers Overview that explains at a high-level what Triggers is, how it works, and what you can do with it.
@bobcatfish
Copy link
Collaborator

Drive by thought: i wonder if the top level README (https://github.com/tektoncd/triggers#tekton-triggers) should contain some of this info, or maybe if some of the content should be removed from there?

Either way it seems like it should definitely link to this overview

@tualeron
Copy link
Contributor Author

Drive by thought: i wonder if the top level README (https://github.com/tektoncd/triggers#tekton-triggers) should contain some of this info, or maybe if some of the content should be removed from there?

Either way it seems like it should definitely link to this overview

This is a great point. In my view, there should only be one README.md, I don't really see the point of two. Is the top-level README.md the one more likely to be read by users? If so, we should move all this content there and delete this secondary one.

If for some reason we can't delete /docs/README.md, then the top-level README.md should act as a landing page that links out to this README.md and a bunch of other useful docs/resources, and we should delete the duplicated content from it.

@dibyom
Copy link
Member

dibyom commented Feb 26, 2021

Either way it seems like it should definitely link to this overview

+1 to linking to the overview.

I think the top level Readme should contain a general overview of the project and then links to more docs!

(Pipelines also follows this pattern)

@tualeron
Copy link
Contributor Author

Either way it seems like it should definitely link to this overview

+1 to linking to the overview.

I think the top level Readme should contain a general overview of the project and then links to more docs!

(Pipelines also follows this pattern)

So should we leave both README.md files in place and remove the duplicated content from the top-level one? See my reply to Christie's comment.

@dibyom
Copy link
Member

dibyom commented Feb 26, 2021

So should we leave both README.md files in place and remove the duplicated content from the top-level one? See my reply to Christie's comment.

Yeah that sounds good to me! And that is also how the Pipeline docs seems to be structured!

@tualeron
Copy link
Contributor Author

I'm updating the top-level README.md to match this new overview and to remove overlapping content. See #975.

@dibyom
Copy link
Member

dibyom commented Feb 26, 2021

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 26, 2021
@tekton-robot tekton-robot merged commit 571b293 into tektoncd:master Feb 26, 2021
tekton-robot pushed a commit that referenced this pull request Feb 26, 2021
Updates the top-level project README.md to link to the new Triggers Overview from #972 and remove overlapping content. Also updates the language for clarity and flow.
@tualeron tualeron deleted the patch-2 branch March 2, 2021 15:23
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. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants