Skip to content

Commit

Permalink
deploy: 910d80d
Browse files Browse the repository at this point in the history
  • Loading branch information
@jnywong
jnywong committed Jan 5, 2024
1 parent 51ba00c commit 12f7c55
Show file tree
Hide file tree
Showing 129 changed files with 26,250 additions and 1,924 deletions.
110 changes: 88 additions & 22 deletions README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@
</script>

<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="_static/styles/theme.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />


<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link href="_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=bd9e20870c6007c4c509" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" />

<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
Expand All @@ -38,9 +38,9 @@
<link rel="stylesheet" type="text/css" href="_static/design-style.4045f2051d55cab465a707391d5b2007.min.css" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=5b4479735964841361fd" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=bd9e20870c6007c4c509" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=bd9e20870c6007c4c509" />
<script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=bd9e20870c6007c4c509"></script>

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
Expand Down Expand Up @@ -74,7 +74,7 @@



<a class="skip-link" href="#main-content">Skip to main content</a>
<a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a>

<div id="pst-scroll-pixel-helper"></div>

Expand Down Expand Up @@ -117,13 +117,21 @@
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>

<header>

<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<div class="bd-header navbar navbar-expand-lg bd-navbar">
</div>

</header>

<div class="bd-container">
<div class="bd-container__inner bd-page-width">





<div class="bd-sidebar-primary bd-sidebar">


Expand All @@ -140,7 +148,7 @@



<a class="navbar-brand logo" href="intro.html">
<a class="navbar-brand logo" href="index.html">



Expand All @@ -161,14 +169,71 @@

<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="intro.html">
Introduction to 2i2c
<a class="reference internal" href="index.html">
Service Guide
</a>
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="the-basic-elements.html">The Basic Elements</a></li>
<li class="toctree-l1"><a class="reference internal" href="edit-handbook.html">Edit this handbook</a></li>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">About the service</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="about/service/options.html">Usecases and prices</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="about/distributions/index.html">Overview of hub features</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/distributions/education.html">Education and teaching</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/distributions/research.html">Research and collaboration</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="about/service/index.html">Our collaborative service model</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="about/service/shared-responsibility.html">Shared responsibility model</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/service/service-objectives.html">Service Level Objectives</a></li>
<li class="toctree-l2"><a class="reference internal" href="about/service/comparison.html">Comparison to similar services</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="https://infrastructure.2i2c.org/reference/hubs/">See a table of our running hubs!</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Use the hub</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="user/topics/policy/index.html">User policies</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="user/topics/policy/code-of-conduct.html">Code of Conduct</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/topics/policy/acceptable-use.html">Acceptable Use Policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/topics/policy/privacy.html">Privacy Policy</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="user/topics/data/index.html">Data and Filesystem</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="user/topics/data/filesystem.html">Filesystem and user directory</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/topics/data/git.html">Use Git / GitHub</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/topics/data/sharing.html">Share data files with your users</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/topics/data/cloud.html">Cloud Object Storage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/howto/specify-unlisted-image.html">Starting and customizing the software environment of a user server</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Administer the hub</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="admin/howto/configurator.html">Configure the hub with the Configurator</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="admin/howto/environment/index.html">User environment and interface</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="admin/howto/environment/hub-user-image-template-guide.html">Create a custom user image for your hub</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="admin/howto/manage-users.html">User authentication and access</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/howto/control-user-server.html">User server management</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/topics/network.html">Network Policy</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Community leadership</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="community/events.html">Events and workshops</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/content.html">Content creation and sharing</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/strategy.html">Community strategy and organizing</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Community representatives</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="admin/howto/new-hub.html">Begin a new hub service</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/howto/replicate.html">Migrate off of a JupyterHub</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/howto/create-billing-account.html">Billing and cloud accounts</a></li>
<li class="toctree-l1"><a class="reference internal" href="topic/cloud-costs.html">Estimate cloud costs</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="about/terminology.html">Terminology reference</a></li>
</ul>

</div>
Expand Down Expand Up @@ -378,7 +443,7 @@ <h2> Contents </h2>


<div id="searchbox"></div>
<article class="bd-article" role="main">
<article class="bd-article">

<section class="tex2jax_ignore mathjax_ignore" id="i2c-community-showcase-handbook">
<h1>2i2c Community Showcase Handbook<a class="headerlink" href="#i2c-community-showcase-handbook" title="Permalink to this heading">#</a></h1>
Expand Down Expand Up @@ -443,6 +508,7 @@ <h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headin

<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
Expand Down Expand Up @@ -502,8 +568,8 @@ <h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headin
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=5b4479735964841361fd"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd"></script>
<script src="_static/scripts/bootstrap.js?digest=bd9e20870c6007c4c509"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=bd9e20870c6007c4c509"></script>

<footer class="bd-footer">
</footer>
Expand Down
Binary file removed _images/Hub.png
View file
Binary file not shown.
Binary file removed _images/Notebook.png
View file
Binary file not shown.
Binary file added _images/access-server.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/add-users-button.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/add-users-form.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/build-workflow.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/coessing-image-quay.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/collaborative_learning_hub.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/configurator.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/download-directory.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image-name-in-build-workflow.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/jupyterlab.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/nbgitpuller-ui.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/new-server-custom-image.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/other-choice.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/pushing-to-registry-job-step.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/rstudio.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/scalable_research_hub.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/secrets.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/server-options.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/shared_responsibility_diagram.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/use-template.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions _sources/about/distributions/education.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
(hub-types:education)=
# Education and teaching

The 2i2c Educational Hubs provide learning environments and infrastructure that is meant for teaching data science.
These hubs are inspired by 2i2c's experience with the [DataHubs at UC Berkeley](https://docs.datahub.berkeley.edu/en/latest/) and the [Syzygy service](https://syzygy.ca/) for Canada.
See the sections below for a description of these hubs and how they are used.

## A brief overview of learning hubs

This hub deployment is designed for distributed learning for students with a variety of backgrounds.

Below is a diagram that showcases some of the major components of this hub:

% automatically downloaded in conf.py
```{figure} /images/collaborative_learning_hub.png
A high level overview of major components in a collaborative learning hub.
```

And here are a few major aspects of these distributions:

Environment
: By default this hub comes iwth a data science environment that covers most introductory workflows in Python and R.
It has been inspired by [the Data 8 course at UC Berkeley](http://data8.org/), and has both Python and R environments for learning.
However, you may also [create your own environment image](environment:image) for your community.
This can then be paired with auto-grading infrastructure such as [Otter Grader](https://otter-grader.readthedocs.io/), which makes grading large courses much easier.

Content
: The hub comes integrated with [nbgitpuller](https://jupyterhub.github.io/nbgitpuller), which allows you to distribute content that is based online in GitHub repositories.
This can be paired with tools like [Jupyter Book](https://jupyterbook.org) to provide online textbooks for your hub.

Interfaces
: This hub comes with both JupyterLab, Jupyter Notebook, and RStudio interfaces by default.

Cloud infrastructure
: The cloud infrastructure needed for this hub is relatively minimal, and defaults to **2GB RAM** and **1 CPU** per user.
This is usually sufficient for most introductory courses.
It can be increased by Hub Administrators, though this will lead to higher cloud costs.

## A common workflow

Below is a common workflow that communities use with this type of hub:

- **Use Jupyter Book for course textbooks**. This allows you to keep all of your source material in markdown files and Jupyter Notebooks, and hosted online as a book for your course.
- **Use `nbgitpuller` links to distribute content to your students**. To distribute worksheets, labs, etc to students, use [nbgitpuller.link](https://jupyterhub.github.io/nbgitpuller/link) to create nbgitpuller links for your content. Clicking these links will give a student their own version of the content that they may modify and save.
- **Use "launch buttons" to connect your book to your hub**. Jupyter Book allows you to [connect your book with a JupyterHub](https://jupyterbook.org/interactive/launchbuttons.html), which students may use to launch directly into your hub from the textbook.

## Inspiration for this hub

Collaborative learning hubs are inspired by 2i2c's experience running the [DataHubs at UC Berkeley](https://docs.datahub.berkeley.edu/en/latest/), which provide interactive environments for thousands of students across campus.
You can find the [online textbook for the course here](https://inferentialthinking.com).
They are also inspired by our experience with the [Syzygy service](https://syzygy.ca/) for Canada, which runs JupyterHubs for institutions across Canada.
Loading

0 comments on commit 12f7c55

Please sign in to comment.