jupyterhub-deploy-teaching icon indicating copy to clipboard operation
jupyterhub-deploy-teaching copied to clipboard

Update documentation

Open willingc opened this issue 8 years ago • 3 comments

Based on feedback from @ellisonbg's experience with CP deployment, we should update the README and Sphinx docs.

  • [ ] Simplify README moving most installation instructions to Sphinx docs
  • [ ] Add some UI screenshots to README
  • [ ] Add a checklist for pre-deployment tasks - Obtain domain name - ssh key creation - DNS routing for server and domain name - encourage letsencrypt (which is working well with current Ansible scripts)
  • [ ] Add user friendly walkthrough of consolidated configuration file and suggested settings

willingc avatar Jan 14 '17 19:01 willingc

Working on checking the README vs. Sphinx, and testing the deployment and seeing if I have any documentation improvement ideas.

rushgeo avatar Aug 26 '17 14:08 rushgeo

Great @rushgeo

willingc avatar Aug 26 '17 15:08 willingc

link to the Cal Poly deployment in the README is no longer working, it's now located here.

cmyceloso avatar Apr 20 '19 17:04 cmyceloso