search

zulip / zulipbot

GitHub workflow-optimizing bot by @zulip
Other
85 stars 65 forks source link

Improve installation documentation #163

Open vsvipul opened 5 years ago

vsvipul commented 5 years ago

Currently, the documentation available here is highly minified. It would be great if someone could make a better documentation on how to host the server on AWS or heroku with screenshots at each step, so that it becomes easier for orgs to setup zulipbot in their respective orgs.

I myself, wasn't able to get it in one go. But after little bit of work, i got it to work.

zulipbot commented 5 years ago

ERROR: Labels "good first issue", "documentation" do not exist and were thus not added to this issue.

vsvipul commented 5 years ago

@synicalsyntax i am willing to create a doc based on heroku, but where do i create. currently, the installation instructions are in wiki. How can i change that ?

jniles commented 5 years ago

Well, I finally got this working.

The documentation for webhook installation is misleading. You need to append the "/github" to the server URL to get it to receive messages and not just silently error with 404.

How does one contribute to the wiki so that I can add this?

harshithpabbati commented 5 years ago

@zulipbot claim

zulipbot commented 5 years ago

Hello @Harshithpabbati!

Thanks for your interest in Zulip! You have attempted to claim an issue without the labels "help wanted", "good first issue". Since you're a new contributor, you can only claim and submit pull requests for issues with the help wanted or good first issue labels.

If this is your first time here, we recommend reading our guide for new contributors before getting started.

harshithpabbati commented 5 years ago

@zulipbot abandon

zulipbot commented 5 years ago

ERROR: You have not claimed this issue to work on yet.