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

Include docs on creating github app for example #18

Open
akerl opened this issue Jul 8, 2019 · 1 comment
Open

Include docs on creating github app for example #18

akerl opened this issue Jul 8, 2019 · 1 comment

Comments

@akerl
Copy link
Member

akerl commented Jul 8, 2019

Would it be possible to add code above the “example” section of the docs, or in a readme in that directory, that walks through the right github app settings for running the example?

As a first-time user of this library, I went to try the example. Running the example server was super straightforward, but I was left to guess at what options to set when creating my github app. Specifically, I had to infer what permissions to ask for, given the description of what the app would do, and I had to search in the code to find what “DefaultWebhookRoute” referred to.

@asvoboda
Copy link
Member

asvoboda commented Jul 8, 2019

I think we'll want to just use https://github.com/palantir/policy-bot#deployment along with some handy screenshots. Then we can probably remove the policy-bot section and just link here for all our bots.

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

2 participants