firepad icon indicating copy to clipboard operation
firepad copied to clipboard

Suggestion: Improve user guide

Open xylo opened this issue 9 years ago • 1 comments

I just managed to set up my own FirePad page, but it took me much longer than I expected. The main problem was that I didn't know that one has to set up security rules in firebase before any example can work. And the identification of this problem took me quite some time.

So, here is what I would improve on https://firepad.io/docs/:

  • explain shortly how to get the API Key (e.g. link to http://stackoverflow.com/questions/13863297/firebase-what-is-the-api-key)
  • one sentence to the <AUTH_DOMAIN> and <DATABASE_NAME>
  • explain that one has to set up security rules for the firebase database

Well, at least the last point should be mentioned in the documentation. Otherwise none of the FirePad examples work.

xylo avatar Sep 07 '16 12:09 xylo

That's a good point. The default rules on a Firebase used to allow unauthenticated writes, but that changed a few months ago. If you're willing to send a Pull Request, the docs are checked in here: https://github.com/firebase/firepad/blob/gh-pages/src/docs/index.md Else, I'll try to get this incorporated at some point.

mikelehen avatar Sep 07 '16 15:09 mikelehen