Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to new table of contents structure #72

Merged
merged 5 commits into from
May 29, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/source/additional-resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Additional resources
====================

*Under development*
4 changes: 4 additions & 0 deletions doc/source/backups.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Backups
=======

*Under development*
6 changes: 3 additions & 3 deletions doc/source/cost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/data-8/jupyterhub-k8s/blob/master/docs/cost-estimation/gce_budgeting.ipynb>`_
estimating the cost for computational resources depending on the student needs.
of CPU and memory usage. Ryan Lovett put together a short `Jupyter notebook
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at some point I should try finalizing this one: http://predictablynoisy.com/HubCost/costs.html

estimating the cost for computational resources <https://github.com/data-8/jupyterhub-k8s/blob/master/docs/cost-estimation/gce_budgeting.ipynb>`_
depending on the student needs.
2 changes: 0 additions & 2 deletions doc/source/create-k8s-cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/extending-jupyterhub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
52 changes: 39 additions & 13 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,50 @@ 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**
**Customization Guide**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a great idea to break it down by topic like this


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

extending-jupyterhub
tools


**Administrator Guide**

This section provides information on managing and maintaining a staging or
production deployment of JupyterHub.

.. toctree::
:maxdepth: 2

resource-mgmt
cost
backups
upgrading
security-considerations
troubleshooting

**Reference**

.. toctree::
:maxdepth: 2
:maxdepth: 2

glossary
additional-resources

extending-jupyterhub
tools
troubleshooting
cost
glossary


.. _JupyterHub: https://github.com/jupyterhub/jupyterhub
Expand Down
4 changes: 4 additions & 0 deletions doc/source/resource-mgmt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Resource management
===================

*Under development*
4 changes: 4 additions & 0 deletions doc/source/security-considerations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Security Considerations
=======================

*Under development*
4 changes: 4 additions & 0 deletions doc/source/upgrading.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Upgrading
=========

*Under development*