From 90506b905d85a93e4dd82f5e406868cbdd787c1b Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Thu, 25 May 2017 12:36:50 -0700 Subject: [PATCH 1/5] Fix title underscore length --- doc/source/extending-jupyterhub.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/extending-jupyterhub.rst b/doc/source/extending-jupyterhub.rst index 695b1353cd..730b56aa71 100644 --- a/doc/source/extending-jupyterhub.rst +++ b/doc/source/extending-jupyterhub.rst @@ -167,7 +167,7 @@ configure JupyterHub to build off of this image. The contents of your GitHub repository might not show up if you have enabled persistent storage. Disable persistent storage if you want them to show up! Pre-populating `$HOME` directory with notebooks when using Persistent Volumes ---------------------------------------------------------------------------- +----------------------------------------------------------------------------- By default, Persistent Volumes are used, so if you would like to include the contents of the github repository in the `$HOME` directory (e.g. all of the `*.ipynb` files), then edit ``config.yaml`` include these lines in it: From 59c407c7c587beaac0ddb1267c578d1f6c3eb19e Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Thu, 25 May 2017 12:37:23 -0700 Subject: [PATCH 2/5] Update toc for new structure --- doc/source/index.rst | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index c1e78b9abd..ddb72c6834 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -31,9 +31,28 @@ questions, feel free to reach out at the `issues page`_. extending-jupyterhub tools - troubleshooting - cost - glossary + + +**Managing the Hub (Admin Guide for Staging and Production)** + +.. toctree:: + :maxdepth: 2 + + resource-mgmt + cost + backups + upgrading + security-considerations + troubleshooting + +**Reference** + +.. toctree:: + :maxdepth: 2 + + glossary + additional-resources + .. _JupyterHub: https://github.com/jupyterhub/jupyterhub From 31f93b98b496444550ca1b1b81588f10608b96ee Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Thu, 25 May 2017 12:38:37 -0700 Subject: [PATCH 3/5] Add skeleton pages for new toc structure --- doc/source/additional-resources.rst | 4 ++++ doc/source/backups.rst | 4 ++++ doc/source/resource-mgmt.rst | 4 ++++ doc/source/security-considerations.rst | 4 ++++ doc/source/upgrading.rst | 4 ++++ 5 files changed, 20 insertions(+) create mode 100644 doc/source/additional-resources.rst create mode 100644 doc/source/backups.rst create mode 100644 doc/source/resource-mgmt.rst create mode 100644 doc/source/security-considerations.rst create mode 100644 doc/source/upgrading.rst diff --git a/doc/source/additional-resources.rst b/doc/source/additional-resources.rst new file mode 100644 index 0000000000..f39bd264d3 --- /dev/null +++ b/doc/source/additional-resources.rst @@ -0,0 +1,4 @@ +Additional resources +==================== + +*Under development* diff --git a/doc/source/backups.rst b/doc/source/backups.rst new file mode 100644 index 0000000000..902e45783e --- /dev/null +++ b/doc/source/backups.rst @@ -0,0 +1,4 @@ +Backups +======= + +*Under development* \ No newline at end of file diff --git a/doc/source/resource-mgmt.rst b/doc/source/resource-mgmt.rst new file mode 100644 index 0000000000..da285812c6 --- /dev/null +++ b/doc/source/resource-mgmt.rst @@ -0,0 +1,4 @@ +Resource management +=================== + +*Under development* \ No newline at end of file diff --git a/doc/source/security-considerations.rst b/doc/source/security-considerations.rst new file mode 100644 index 0000000000..f7b4368b48 --- /dev/null +++ b/doc/source/security-considerations.rst @@ -0,0 +1,4 @@ +Security Considerations +======================= + +*Under development* diff --git a/doc/source/upgrading.rst b/doc/source/upgrading.rst new file mode 100644 index 0000000000..b5862c077d --- /dev/null +++ b/doc/source/upgrading.rst @@ -0,0 +1,4 @@ +Upgrading +========= + +*Under development* \ No newline at end of file From 6f11eccce386484f9ad28a13ad881b4cf98ff278 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Thu, 25 May 2017 20:08:08 -0700 Subject: [PATCH 4/5] Edit rst for style --- doc/source/cost.rst | 6 +++--- doc/source/create-k8s-cluster.rst | 2 -- doc/source/index.rst | 23 +++++++++++++---------- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/doc/source/cost.rst b/doc/source/cost.rst index b4514379d6..7de48cc483 100644 --- a/doc/source/cost.rst +++ b/doc/source/cost.rst @@ -56,6 +56,6 @@ Data 8 The Data 8 course at UC Berkeley used a JupyterHub to coordinate all course material and to provide a platform where students would run their code. This consisted of many hundreds of students, who had minimal requirements in terms -of CPU and memory usage. Ryan Lovett put together -`a short jupyter notebook `_ -estimating the cost for computational resources depending on the student needs. +of CPU and memory usage. Ryan Lovett put together a short `Jupyter notebook +estimating the cost for computational resources `_ +depending on the student needs. diff --git a/doc/source/create-k8s-cluster.rst b/doc/source/create-k8s-cluster.rst index 533d29dff4..7b611f8f63 100644 --- a/doc/source/create-k8s-cluster.rst +++ b/doc/source/create-k8s-cluster.rst @@ -128,8 +128,6 @@ Setting up Kubernetes on Microsoft Azure Container Service (ACS) --resource-group=${RESOURCE_GROUP} \ --name=${CLUSTER_NAME} - - where: * ``--resource-group`` specifies your Azure resource group. diff --git a/doc/source/index.rst b/doc/source/index.rst index ddb72c6834..aaf264da8b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,24 +16,27 @@ questions, feel free to reach out at the `issues page`_. **Creating your JupyterHub** .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - getting-started - create-k8s-cluster - setup-helm - setup-jupyterhub - turn-off + getting-started + create-k8s-cluster + setup-helm + setup-jupyterhub + turn-off **Extra info and tips** .. toctree:: - :maxdepth: 2 + :maxdepth: 2 + + extending-jupyterhub + tools - extending-jupyterhub - tools +**Administrator Guide** -**Managing the Hub (Admin Guide for Staging and Production)** +This section provides information on managing and maintaining a staging or +production deployment of JupyterHub. .. toctree:: :maxdepth: 2 From f46e048a28418423a43af42b47f34ed207fc972d Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 29 May 2017 07:41:42 -0700 Subject: [PATCH 5/5] Add customization section header --- doc/source/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index aaf264da8b..2b0483a692 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,7 +24,11 @@ questions, feel free to reach out at the `issues page`_. setup-jupyterhub turn-off -**Extra info and tips** +**Customization Guide** + +JupyterHub can be configured and customized to fit a variety of deployment +requirements. This guide helps outline how to customize and extend a JupyterHub +deployment. .. toctree:: :maxdepth: 2