-
Notifications
You must be signed in to change notification settings - Fork 420
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
Conversation
There was a problem hiding this 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!
[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 |
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.
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. |
+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. |
Yeah that sounds good to me! And that is also how the Pipeline docs seems to be structured! |
I'm updating the top-level README.md to match this new overview and to remove overlapping content. See #975. |
/lgtm |
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.
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:
See the contribution guide for more details.
Release Notes