Changing jupyterhub theming documentation due to changes
-# Themeing
+# Theming
## JupyterHub Theme
The QHub theme was originally based off the [work of the pangeo
team](https://github.com/pangeo-data/pangeo-custom-jupyterhub-templates)
and is now located in
-[github.com/Quansight/qhub-jupyterhub-theme](https://github.com/Quansight/qhub-jupyterhub-theme/). The
-simplest solution would be to Fork the github repo and customize the
-theme to your needs. In addition to creating a new repo for the github
-theme you will need to modify the `infrastructure/jupyterhub.yaml`
-script. Setting `c.JupyterHub.template_vars` allows you to customize
-the variables within your jinja template theme. Additionally you will
-need to change the `repository` and `revision`.
+[github.com/Quansight/qhub-jupyterhub-theme](https://github.com/Quansight/qhub-jupyterhub-theme/). For
+simple modifications to the jupyterhub theme we suggest only editing
+`infrastructure/jupyterhub.yaml` and the value
+`c.JupyterHub.template_vars`. For most use cases this should provide
+enough flexibility.
```yaml
hub:
extraConfig:
- 01-jupyterlab: |
- c.Spawner.cmd = ['jupyter-labhub']
-
customPodHook: |
c.JupyterHub.template_paths = ['/usr/local/share/jupyterhub/custom_templates/']
c.JupyterHub.template_vars = {
@@ -26,23 +21,17 @@ hub:
'pangeo_hub_subtitle': 'Autoscaling Compute Environment on Digital Ocean',
'pangeo_welcome': """Welcome to ${{ cookiecutter.endpoint }}. It is maintained by the <a href="http://quansight.com">Quansight staff</a>. The hub's configuration is stored in the github repository based on <a href="https://github.com/Quansight/qhub-kubernetes/">https://github.com/Quansight/qhub-kubernetes/</a>. To provide feedback and report any technical problems, please use the <a href="https://github.com/Quansight/qhub-kubernetes//issues">github issue tracker</a>."""
}
- extraVolumes:
- - name: custom-templates
- gitRepo:
- repository: "https://github.com/Quansight/qhub-jupyterhub-theme.git"
- revision: "53edc55d0bdd5944fb6dee2d10af90da8faf191d"
- extraVolumeMounts:
- - mountPath: /usr/local/share/jupyterhub/custom_templates
- name: custom-templates
- subPath: "qhub-jupyterhub-theme/templates"
- - mountPath: /usr/local/share/jupyterhub/static/extra-assets
- name: custom-templates
- subPath: "qhub-jupyterhub-theme/extra-assets"
```
-> TODO: should we bake the theme into a custom jupyterhub docker image?
-> This would be easy and would be similar to the approach we take with
-> themeing jupyterlab. Not to mention testing would be easier.
+For more serious modifications to the jupyterhub theme you will need
+to fork
+[Quansight/qhub-jupyterhub-theme](https://github.com/Quansight/qhub-jupyterhub-theme)
+and edit the jupyterhub Dockerfile located at
+`image/Dockerfile.jupyterhub`. Modify the `THEME_OWNER`, `THEME_REPO`,
+and `THEME_REV`. This should change the Dockerfile to use your new
+theme. The
+[Quansight/qhub-jupyterhub-theme](https://github.com/Quansight/qhub-jupyterhub-theme)
+has detailed documentation.
## Jupyterlab Theme
