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
adding when to use tljh page #118
Conversation
Lots of strong opinions I have, but both my wrists are acting up now :( @choldgraf can I hopefully talk to you in person about this? Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
THESE WERE ACTUALLY WRITTEN BY CHRIS WITH YUVI'S LAPTOP
docs/topic/whentouse.rst
Outdated
Many of these ideas were first laid out in a | ||
`blog post announcing TLJH <http://words.yuvi.in/post/the-littlest-jupyterhub/>`_. | ||
|
||
The Littlest JupyterHub |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
double check heading styles in the "doc style guide"
docs/topic/whentouse.rst
Outdated
----------------------- | ||
|
||
The Littlest JupyterHub (TLJH) is an opinionated and pre-configured distribution | ||
to deploy a JupyterHub on a single virtual machine (or your own hardware). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...deploy a JupyterHub on a single machine (in the cloud or on your own hardware)
docs/topic/whentouse.rst
Outdated
|
||
The Littlest JupyterHub (TLJH) is an opinionated and pre-configured distribution | ||
to deploy a JupyterHub on a single virtual machine (or your own hardware). | ||
It is designed to be a more lightweight, flexible, and maintainable solution |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
be careful about the word flexible as it is highly context-dependent. TLJH is highly non flexible for things like the decisions made in deploying a jupyterhub. We should find a new word or remove this one
docs/topic/whentouse.rst
Outdated
* You want to provide easy access to a shared computational resource (CPU, RAM, data, etc) | ||
* You only need to support up to ~100 people | ||
* You aren't concerned about `over-provisioning your cluster <https://community.spiceworks.com/cloud/article/overprovisioning-servers-iaas>`_. | ||
* You don't need production-level security promises for your deployment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this line - TLJH actually has very high potential for security!
docs/topic/whentouse.rst
Outdated
^^^^^^^^^^^^^^^^^^ | ||
|
||
* Simpler to deploy on many kinds of cloud services | ||
* Faster to set up and tear down |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this comment has nothing to do with this line. Maybe we should split up the "index.rst" sections into sub-sections rather than having a single "how-to" section
=================================== | ||
When to use The Littlest JupyterHub | ||
=================================== | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GENERAL POINT, MAY INVALIDATE OTHER COMMENTS: We could probably remove a lot of this content, and boil it down to two main decision points:
- Do you want your hub and all users to live on a single machine vs. putting them on a cluster of machines that are scaled up or down.
- Do you need to use container technology of some kind. We should find some bells and whistles to motivate this.
OK, I pushed a page that is much lighter on content and makes less opinionated statements about pros/cons, instead focusing on the decision questions to ask. LMK what you think! |
I like it! |
This adds a page to try disambiguating when to use TLJH vs. Z2JH. It partially addresses #75 .
I'm sure that I got some points wrong or didn't explain them well. Feel free to push directly to the branch or make suggestions!