Review README and install docs

jupyterhub / jupyterhub-deploy-teaching

Reference deployment of JupyterHub and nbgrader on a single server

http://jupyterhub-deploy-teaching.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

247 stars 85 forks source link

Review README and install docs #33

Open willingc opened 8 years ago

willingc commented 8 years ago

Now that @minrk's #28 has been merged, the README and install docs should be reviewed for accuracy.

willingc commented 8 years ago

I tried to set up on a Digital Ocean instance Ubuntu 16.04 last night and ran into some instructions that could be improved:

[ ] setting hosts
[ ] let's encrypt process on 16.04 Ubuntu and certbot

Note:
Ubuntu Xenial has an old version of Certbot packaged for it that lacks a few features.
The webroot plugin doesn't have an interactive mode, so you'll need to specify your
domains and webroot paths on the command line to use this plugin.

minrk commented 8 years ago

The webroot interactive mode shouldn't be an issue, since we can't use interactive mode on ansible.

How would you improve the host-setting?

willingc commented 8 years ago

Hey Min, Thanks for pointing out the webroot interactive mode as I realized later that the ansible scripts were handling the let's encrypt cert creation.

As for the host setting, it wasn't clear to me from the documentation (lol) that I was simply taking hosts.example, entering my host info, and saving as hosts.

Overall, I'm not satisfied that the docs are user focused enough (lots of bouncing between the README, docs, and source code). I'm going to try to improve that. The Digital Ocean droplet on Ubuntu 16.04 is my first user test on this.

minrk commented 8 years ago

Sounds great, looking forward to it.