-
Notifications
You must be signed in to change notification settings - Fork 417
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
Create getting started guide #13
Comments
/assign |
It seem like this is mostly done? The installation (since we currently have no release) is specified in the DEVELOPMENT.md. To my understanding, the other two points seem to be sufficient as well. Maybe additionally link/add this https://github.com/tektoncd/triggers/blob/master/DEVELOPMENT.md#install-triggers to the top level README? |
Not sure how to proceed with this for now. |
@iancoffey I wonder if the getting start doc is the good place to put the reference to the create Webhooks doc? |
@akihikokuroda Yes, this sounds like a good place to me! I had been waiting for #74 to land before beginning this guide but an install guide sounds like a nice start. |
@iancoffey we've got #74 now!! 🎉 🎉 🎉 |
FYI, just approved a PR fleshing out our @iancoffey can you please reference this in the Getting Started guide? |
Pardon the delay on this! I have a good start here and should push something for yall to validate this coming week. |
I have opened an early WIP pr here and should have the branch done this week -> #135 Since there are several good documents in this repo already, the idea behind this guide is to focus on making sure an operators first real Triggers project starts off well by building a real system. It will use the webhook task and highlight the RBAC aspect of the triggers a bit too, when complete. |
#135 is merged, so closing this issue. |
Expected behavior
People who want to use Triggers should have an obvious place to look for some quick start docs on how they can get up and running, e.g.:
Actual behavior
In #2 we'll add a DEVELOPMENT.md for contributors, but we won't have any getting started docs for users.
Additional info
May want to use https://github.com/tektoncd/pipeline/blob/master/docs/tutorial.md as an example.
The text was updated successfully, but these errors were encountered: