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

Create getting started guide #13

Closed
bobcatfish opened this issue Jun 23, 2019 · 10 comments
Closed

Create getting started guide #13

bobcatfish opened this issue Jun 23, 2019 · 10 comments
Assignees
Milestone

Comments

@bobcatfish
Copy link
Collaborator

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.:

  • How to install and setup
  • What the types are and how to use them
  • Where to look for more

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.

@vtereso
Copy link

vtereso commented Aug 6, 2019

/assign

@vtereso
Copy link

vtereso commented Aug 6, 2019

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?

@vtereso
Copy link

vtereso commented Aug 8, 2019

Not sure how to proceed with this for now.
/unassign

@iancoffey iancoffey self-assigned this Aug 16, 2019
@akihikokuroda
Copy link
Member

@iancoffey I wonder if the getting start doc is the good place to put the reference to the create Webhooks doc?
#82 (review)

@iancoffey
Copy link
Member

@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.

@bobcatfish
Copy link
Collaborator Author

@iancoffey we've got #74 now!! 🎉 🎉 🎉

@bobcatfish bobcatfish added this to the Triggers 0.1 milestone Sep 12, 2019
@ncskier
Copy link
Member

ncskier commented Sep 12, 2019

FYI, just approved a PR fleshing out our examples with a README and RBAC support: #113.

@iancoffey can you please reference this in the Getting Started guide?

@iancoffey
Copy link
Member

Pardon the delay on this! I have a good start here and should push something for yall to validate this coming week.

@iancoffey
Copy link
Member

iancoffey commented Sep 24, 2019

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.

@ncskier
Copy link
Member

ncskier commented Oct 16, 2019

#135 is merged, so closing this issue.

@ncskier ncskier closed this as completed Oct 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants