improve docs

[bitnik]

this PR improves docs based on #5 (comment)

@sgibson91 I would be happy if you could review :)

Document the gotcha about dummy IPs. Folks like me coming from cloud-based BHub deployments would probably expect the chart to "just work" and we update it with the IP addresses when they're created. Explicitly saying that this chart won't work that way will save some confusion.

For this I made a PR in binderhub repo: jupyterhub/binderhub#1139

Document how and why the hub/binder URLs are different from the standard BHub. Again coming from the standard chart, I would never have assumed that these values needed to be different. Also a little bit of explanation as to why it's set up that way might be nice for the curious, and also admins who may need to debug at some point.

Hopefully this is better documented now.

The URLs provided to the OAuth Provider are different than those described in the z2jh auth docs. With the explanation about the URLs from the previous point, this need be nothing more than "Here's the z2jh auth guide. Remember, the URLs you will be providing are the following..."

I guess here you confused the config for jupyterhub.hub.services.binderhub with jupyterhub.auth?

[bitnik]

@manics thanks a lot!

[sgibson91]

I guess here you confused the config for jupyterhub.hub.services.binderhub with jupyterhub.auth?

No when I was configuring the GitHub OAuth App, I set the Homepage URL (pic below) to be http://<JupyterHub_IP>/services/binder which is a deviation from what the z2jh docs on for auth. Unless I set it up incorrectly?

The rest looks great :)

[bitnik]

Thanks a lot!

No when I was configuring the GitHub OAuth App, I set the Homepage URL (pic below) to be http://<JupyterHub_IP>/services/binder which is a deviation from what the z2jh docs on for auth. Unless I set it up incorrectly?

I think "Homepage URL" should be "http://<JupyterHub_IP>", since JupyterHub home is the main page for the persistent BinderHub.

[sgibson91]

Oh, I actually had it as JupyterHub_IP/hub/home which is probably what JupyterHub_IP resolves to, right? Anyway, any documentation that reduces that makes that clearer is gonna be a plus :)

[bitnik]

Oh, I actually had it as JupyterHub_IP/hub/home which is probably what JupyterHub_IP resolves to, right?

Yes, exactly.

I will merge this now and do more improvements later :)