Teach JupyterHub (#68)

* Howto access jupyter.crc that is integrated with the Teach Cluster.

* Fixed Codacy flagged issues.

* Fixed annotation typo in image.

docs/getting-started/jupyter-teach.md

@@ -0,0 +1 @@
+--8<-- "jupyter-teach.md"

docs/getting-started/step2/index.md

@@ -12,6 +12,7 @@ several portals, including
 * [**Linux Desktop webportal**](../viz.md)
 * [**Open OnDemand webportal**](../open-ondemand.md)
 * [**JupyterHub webportal**](../jupyter-hub.md)
+* [**JupyterHub on Teach Cluster**](../jupyter-teach.md)
 
 A schematic of this part of the process is highlighted below.
 

docs/snippets/jupyter-hub.md

@@ -1,5 +1,11 @@
 # Jupyter Hub
 
+!!! warning "Deprecation Notice"
+
+    hub.crc.pitt.edu will be retired during the next quarterly maintenance, scheduled for early Jan 2025. Courses should use the new 
+    jupyter.crc.pitt.edu that is integrated with the compute nodes on the Teach Cluster. Researchers should use 
+    Jupyter through Open On-Demand.
+
 ## **Summary**
 
 In addition to Jupyter notebook sessions via Open OnDemand, CRC also hosts the functionality for the multi-user equivalent

docs/snippets/jupyter-teach.md

@@ -0,0 +1,67 @@
+# JupyterHub on the Teach Cluster
+
+[JupyterHub](https://jupyter.org/hub) provides students access to Jupyter notebooks with the capability of connecting to dedicated
+computing resources on the Teach Cluster. Through this webportal, students can request access to CPU and GPU compute nodes for classwork.
+
+## Step 1. Connecting to JupyterHub 
+
+Point your browser to the address below and authenticate using your Pitt credentials. The username needs to be all lowercase and is the
+same one used to access my.pitt.edu. The web host should be accessible for all users while connected through Wireless-PittNet. If that is 
+not the case, please try again while on [VPN](https://services.pitt.edu/TDClient/33/Portal/KB/ArticleDet?ID=293).
+
+* **web hostname:** [https://jupyter.crc.pitt.edu](https://jupyter.crc.pitt.edu)
+* **authentication credentials:** Pitt username (all lowercase) and password
+
+![](../_assets/img/jupyter/jupyter-1.png)
+
+## Step 2. Selecting Resources
+
+The **Select a job profile** dropdown menu provides several preset configurations. Please submit 
+a [help ticket](https://services.pitt.edu/TDClient/33/Portal/Requests/TicketRequests/NewForm?ID=yXkHi62rHa8_&RequestorType=Service)
+if you want us to create a custom profile for your class. 
+
+![](../_assets/img/jupyter/jupyter-2.png)
+
+The *Host Process* profile will run the Jupyter Notebook on the VM server hosting the JupyterHub
+webportal. Our recommendation is that you do not choose *Host Process* but instead select one of the dedicated resources on the Teach
+Cluster.
+
+![](../_assets/img/jupyter/jupyter-3.png)
+
+Pressing *Start* will launch the job to the Teach Cluster and send back a Jupyter Notebook on the web GUI.
+
+![](../_assets/img/jupyter/jupyter-4.png)
+
+![](../_assets/img/jupyter/jupyter-5.png)
+
+## Step 3. Interacting with the Jupyter Notebook
+
+If you encounter success, you will see the GUI below. The [Project Jupyter site](https://docs.jupyter.org/en/latest/) has good documentation 
+on all aspects of the GUI. 
+
+Should you be unsuccessful in getting a Jupyter Notebook instance, please submit a 
+[help ticket](https://services.pitt.edu/TDClient/33/Portal/Requests/TicketRequests/NewForm?ID=yXkHi62rHa8_&RequestorType=Service)
+and we will troubleshoot. A potential error could be that your account does not have an allocation on the Teach Cluster. A symptom
+of this error is shown in the [Appendix](#appendix-errors) at the bottom.
+
+![](../_assets/img/jupyter/jupyter-6.png)
+
+## Step 4. Ending session
+
+Be sure to save all your work before ending your session.
+
+![](../_assets/img/jupyter/jupyter-8.png)
+
+Select the *Hub Control Panel* to bring up the option to stop the server.
+
+![](../_assets/img/jupyter/jupyter-9.png)
+
+![](../_assets/img/jupyter/jupyter-10.png)
+
+## **Appendix: Errors**
+
+Your request for a Jupyter Notebook on the Teach Cluster will fail if your account does not have an allocation there. The error may
+manifest as shown below.
+
+![](../_assets/img/jupyter/jupyter-error-1.png)
+![](../_assets/img/jupyter/jupyter-error-2.png)

docs/web-portals/jupyter-teach.md

@@ -0,0 +1 @@
+--8<-- "jupyter-teach.md"

mkdocs.yml

@@ -77,6 +77,7 @@ nav:
       - Linux Desktop Webportal: getting-started/viz.md
       - Open OnDemand Webportal: getting-started/open-ondemand.md
       - JupyterHub Webportal: getting-started/jupyter-hub.md
+      - JupyterHub on Teach Cluster: getting-started/jupyter-teach.md
     - Step 3- CRC Ecosystem:
       - getting-started/step3/index.md
       - Discovering Software: getting-started/step3/getting-started-step3-software.md
@@ -92,6 +93,7 @@ nav:
     - web-portals/jupyter-ondemand.md
     - web-portals/viz.md
     - web-portals/jupyter-hub.md
+    - web-portals/jupyter-teach.md
     - web-portals/psych.md
   - The SLURM Workload Manager:
     - slurm/slurm-overview.md