Merge pull request #30 from ryanlovett/unwidth

Remove image widths. Create support section.
berkeley-cdss · Oct 25, 2024 · 6560575 · 6560575
2 parents 17587af + a3ee087
commit 6560575
Show file tree

Hide file tree

Showing 20 changed files with 81 additions and 103 deletions.
diff --git a/_toc.yml b/_toc.yml
@@ -64,6 +64,11 @@ parts:
   - file: workflow/r-datahub
   - file: faq/share
     title: Sharing information about the Hub
+- caption: Support
+  chapters:
+  - file: support/contact-us
+  - file: support/common-requests
+  - file: support/github
 - caption: DataHub Frequently Asked Questions (FAQ)
   chapters:  
   - file: faq/onboarding

diff --git a/faq/admin.md b/faq/admin.md
@@ -21,7 +21,6 @@ Elevated privileges are hub-wide. If you have a GSI teaching your course using a
 Check this image to know your privileges for the admin option,
 
 ```{figure} ../images/admin.png
-:width: 500px
 :align: center
 :name: DataHub Admin dashboard
 
@@ -57,7 +56,6 @@ Follow the steps below to navigate admin interface:
 - Click the admin option from the top bar
 
 ```{figure} ../images/adminaccess.PNG
-:width: 500px
 :align: center
 :name: DataHub Admin options
 
@@ -77,7 +75,6 @@ If you are using the R hub, then you may need to follow the below steps,
 - Click on the control panel
 
 ```{figure} ../images/controlpanel.PNG
-:width: 500px
 :align: center
 :name: Control Panel
 
@@ -86,7 +83,6 @@ Here is how the control panel option looks like!
 - Click admin option
 
 ```{figure} ../images/adminaccess.PNG
-:width: 500px
 :align: center
 :name: DataHub Admin access
 
@@ -95,7 +91,6 @@ Here is where you can find admin option!
 - Find the user whose server you want to restart.
 
 ```{figure} ../images/user.PNG
-:width: 500px
 :align: center
 :name: User List
 
@@ -119,7 +114,6 @@ Here is how to search for an user!
 
 
 ```{figure} ../images/accessserver.PNG
-:width: 500px
 :align: center
 :name: Access Server
 

diff --git a/faq/onboarding.md b/faq/onboarding.md
@@ -21,21 +21,6 @@
 
 **Otter Grader Upgrade:** If you are interested in moving to the latest versions of otter-grader then please reach out to [email protected] and [email protected].
 
-##### DataHub - Support Overview 
-
-**GitHub Issues:** The best way for instructional staff to request help with the DataHub is through filing an issue using the [GitHub templates](https://github.com/berkeley-dsep-infra/datahub/issues/new/choose).
-
-**Slack Channel:** If you have anything you'd like to discuss with w/the infra team, please join the Slack channel. Access [uctech.slack.com](http://uctech.slack.com/) (anyone with a berkeley.edu account can get in) and join the #ucb-datahubs channel to interact with the infra team.
-
-**DataHub Service Lead:** In addition, you can reach out to Balaji Alwar <[email protected]> directly if there are time-sensitive issues.
-
-##### DataHub - Common Requests 
-**Packages:** Please test your assignments for hub compatibility before the start of the semester. Check whether all the needed Python/R packages and their required versions are installed. If not, please use the [package request template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=felder%2Cbalajialg&labels=package-request&template=package_request.yml&title=Request+python+package+X+for+class+Y) to raise a request to the infra team.  The Infra team requires at least 2 business days for a turnaround on support requests such as this.
-
-**Elevated Privilege Access:** You can use this [GitHub template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=balajialg&labels=support&template=admin_request.yml) to request [elevated privileges](admin?highlight=admin) for course staff to troubleshoot student servers in the requested hub.
-
-**Big Assignments / High Use times:** You can share the important date(s)/time(s) for workshops/exams/assignments etc. when you expect the resource requirement to be greater than usual. We will review your request and get back to you directly about the feasibility of increasing resources. You can provide us with all the relevant information using the [calendar event scheduling template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=felder%2Cbalajialg&labels=support&template=resourcescheduler.yml&title=Increase+compute+resources+for+Course+XXX+between+specific+date%28s%29%2Ftime%28s%29).
-
 ##### Other Updates
 
 **a11y Documentation:** For further insights into improving the accessibility of the Jupyter Notebook/Lab experience for students, please review this [documentation](accessibility?highlight=accessibility) that provides a few tips for improving the accessibility of the notebooks.
@@ -68,54 +53,13 @@ We have 15+ hubs which cater to the diverse needs of the campus audience. We hav
 - If your consumed memory is greater than the available memory for your instance then your server will crash resulting in you either optimizing your workflow to be less compute intensive or requesting additional RAM,
 
 ```{figure} ../images/memory.png
-:width: 500px
 :align: center
 :name: Available Memory
 
 Here is where you can find the memory related details!
 ```
 Please contact us if your course/research has more complex computation requiring increased capacity.
 
-**What are the different services offered?**
-
-We offer UI for Classic Jupyter Notebook, RStudio and JupyterLab across different hubs. You can learn more about the varied services offered through this jupyterhubs services [documentation](https://docs.datahub.berkeley.edu/en/latest/users/services.html).
-
-
-**What is the process to raise Github issues? How can I track the raised issues?**
-
-If you want to raise a bug, you can use this [link](https://github.com/berkeley-dsep-infra/datahub/issues/new/choose) to submit your issues.
-
-**When do I receive a response when an issue gets raised?**
-
-```{note}
-Please refer to the below Service Level Agreement (SLA) for varied requests. Time for this SLA will start from the time when we have complete information regarding your request,
-```
-
-- SLA for package installation: "Acknowledgement within two working days."
-- SLA for RAM increase: "Acknowledgement within two working days."
-- SLA for admin access: "Request completed within two working days."
-- SLA for data archival request: "Request completed within three working days."
-
-**Are there existing templates for submitting requests to the infrastructure team?**
-
-We have categorized common requests we get from our users into templates that you can repurpose to make your request. You can refer to the following templates catering to varied scenarios,
-
-**Raise Bugs:** If you found a bug in the workflow, Please use this [template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=bug&template=bug_report.yml) to raise an issue.
-
-**Share New Enhancement:** If you envision a new feature/documentation that would help your existing workflow, please use this [template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=type%3A+enhancement&template=featurerequest.md) to submit a request.
-
-**Request Package Addition/Change:** If you want to install new packages in R/Python/Julia as part of your hub, please raise a request using this [template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=support&template=datahub-package-addition---change-request.md&title=Request+python+package+X+for+class+Y).
-
-**Request for RAM/CPU:** If you want to increase/decrease RAM for a specific hub then please use this [template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=support&template=higher-resources.md&title=Request+more+RAM+for+class+X) to make the request.
-
-**Request Admin Access:** If you want members of your teaching team to have admin access then please use this [template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=support&template=admin_request.yml) to make this request.
-
-**Retrieve User Data:** If you want to request data stored as part of your hub instance, then please do use this [template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=support&template=data_archival_request.yml) to raise a request
-
-```{note}
-If these templates are not exhaustive enough to cover the type of issue you are raising, you can use this [generic template](https://github.com/berkeley-dsep-infra/datahub/issues/new) to raise your issue.
-```
-
 **As an instructor what do I need to do to set up the hub for my course?**
 
 Honestly, nothing! You are free to use the DataHub starting today.
@@ -142,20 +86,17 @@ We recommend that you use the following options,
 
 - **For Jupyter Notebooks:** Select File -> Download as -> WebPDF to download the PDF version of your notebook.
 ```{figure} ../images/downloadhtml.PNG
-:width: 500px
 :align: center
 :name: Downloading notebook as a PDF 
 Here is where you can find the option to download the Python notebook as a PDF!
 ```
 - **For R files:** Select File -> Knit Document -> Select the target folder -> Select the Output Format as PDF to save the PDF version of the file
  ```{figure} ../images/knitting.PNG
-:width: 500px
 :align: center
 :name: Downloading R notebook as a PDF
 Here is where you can find the option to download the R file!
 ```
 ```{figure} ../images/knittingpdf.PNG
-:width: 500px
 :align: center
 :name: Knitting a PDF
 Here is where you can find the option to specify the download format as PDF!

diff --git a/support/common-requests.md b/support/common-requests.md
@@ -0,0 +1,15 @@
+---
+title: Common Requests
+---
+
+## Packages
+
+Please test your assignments for hub compatibility before the start of the semester. Check whether all the needed Python/R packages and their required versions are installed. If not, please use the [package request template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=felder%2Cbalajialg&labels=package-request&template=package_request.yml&title=Request+python+package+X+for+class+Y) to raise a request to the infra team.  The Infra team requires at least 2 business days for a turnaround on support requests such as this.
+
+## Elevated Privilege Access
+
+You can use this [GitHub template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=balajialg&labels=support&template=admin_request.yml) to request [elevated privileges](admin?highlight=admin) for course staff to troubleshoot student servers in the requested hub.
+
+## Big Assignments / High Use times
+
+You can share the important date(s)/time(s) for workshops/exams/assignments etc. when you expect the resource requirement to be greater than usual. We will review your request and get back to you directly about the feasibility of increasing resources. You can provide us with all the relevant information using the [calendar event scheduling template](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=felder%2Cbalajialg&labels=support&template=resourcescheduler.yml&title=Increase+compute+resources+for+Course+XXX+between+specific+date%28s%29%2Ftime%28s%29).
diff --git a/support/contact-us.md b/support/contact-us.md
@@ -0,0 +1,15 @@
+---
+title: Contact Us
+---
+
+## GitHub Issues
+
+The best way for instructional staff to request help with the DataHub is through filing a [GitHub issue](github.md).
+
+## Slack Channel
+
+If you have anything you'd like to discuss with w/the infra team, please join the Slack channel. Access [uctech.slack.com](http://uctech.slack.com/) (anyone with a berkeley.edu account can get in) and join the #ucb-datahubs channel to interact with the infra team.
+
+## DataHub Service Lead
+
+In addition, you can reach out to Balaji Alwar <[email protected]> directly if there are time-sensitive issues.
diff --git a/support/github.md b/support/github.md
@@ -0,0 +1,44 @@
+---
+title: GitHub Issues
+---
+
+## Create an Issue
+
+We have categorized common user requests into [templates](https://github.com/berkeley-dsep-infra/datahub/issues/new/choose). Some of them are described below.
+
+[Bug Report](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=bug&template=bug_report.yml)
+: You found a bug in any part of the software stack.
+
+[Share New Enhancement](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=type%3A+enhancement&template=featurerequest.md)
+: You envision a new feature/documentation that would help your existing workflow.
+
+[Request Package Addition/Change](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=support&template=datahub-package-addition---change-request.md&title=Request+python+package+X+for+class+Y)
+: You want to install new packages in R/Python/Julia as part of your hub.
+
+[Request for RAM/CPU](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=support&template=higher-resources.md&title=Request+more+RAM+for+class+X)
+: You want to increase/decrease RAM for a specific hub.
+
+[Request Elevated Privileges](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=support&template=admin_request.yml)
+: You want members of your teaching team to have elevated privileges.
+
+[Retrieve User Data](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=support&template=data_archival_request.yml)
+: You want to request data stored as part of your hub instance.
+
+[Generic Issue](https://github.com/berkeley-dsep-infra/datahub/issues/new)
+: For any other issue.
+
+## Service Level Agreement for Issues
+
+Time for this SLA will start from the time when we have complete information regarding your request,
+
+Package installation
+: Acknowledgement within two working days.
+
+RAM increase
+: Acknowledgement within two working days.
+
+Elevated privileges
+: Request completed within two working days.
+
+Data archival request
+: Request completed within three working days.
diff --git a/technology/jupyter/troubleshoot-nbgitpuller.md b/technology/jupyter/troubleshoot-nbgitpuller.md
@@ -40,7 +40,6 @@ The easiest and most conservative solution is to rename the file or folder that
 
 When you face an error like below, do the following steps
 ```{figure} ../../images/mergeconflict.png
-:width: 500px
 :align: center
 :name: DataHub Admin
 
@@ -49,7 +48,6 @@ Here is how the admin dashboard looks like!
 
 - Rename the existing folder where the merge conflict error arose
 ```{figure} ../../images/tshoot.PNG
-:width: 500px
 :align: center
 :name: Folder Rename!
 
@@ -66,7 +64,6 @@ If you have command line experience then you can use "git stash" command in term
 - On the upper right of the page, click the dropdown menu that says “New” and select “Terminal”.
 
 ```{figure} ../../assets/terminal.png
-:width: 500px
 :align: center
 :name: Launch Terminal
 
@@ -77,7 +74,6 @@ Launch a terminal
 - Run `git stash` command in the terminal and you will see the following output
 
 ```{figure} ../../assets/gitstash_output.png
-:width: 500px
 :align: center
 :name: git stash output
 

diff --git a/technology/jupyterlab.md b/technology/jupyterlab.md
@@ -5,7 +5,6 @@ title: JupyterLab
 [JupyterLab](https://jupyterlab.readthedocs.io) is "a highly extensible, feature-rich notebook authoring application and editing environment." Most courses on DataHub use JupyterLab as the primary user-facing application.
 
 ```{figure} ../images/jupyterlab.png
-:width: 500px
 :align: center
 :name: JupyterLab Screenshot
 

diff --git a/technology/pedagogy-and-technology/introduction-to-jupyter-rkernel.md b/technology/pedagogy-and-technology/introduction-to-jupyter-rkernel.md
@@ -35,15 +35,13 @@ jupyter lab
 Step 5: Now, from the launcher tab, choose R kernel to start a new notebook.
 
 ```{figure} ../images/launcher_tab_r_kernel.jpg
-:width: 500px
 :align: center
 :name: Jupyter Notebook Launcher Tab with R Kernel
 ```
 
 The following is a screenshot of Jupyter notebook having R kernel.
 
 ```{figure} ../images/jupyter_notebook_r_kernel.jpg
-:width: 500px
 :align: center
 :name: Jupyter Notebook with R Kernel
 ```
@@ -62,4 +60,4 @@ Step 3: If not installed, Install tidyverse package using the following command
 
 ```{code}
 devtools::install_github("tidyverse/tidyverse")
-```
+```
diff --git a/technology/quarto.md b/technology/quarto.md
@@ -5,7 +5,6 @@ title: Quarto
 [Quarto](https://quarto.org) is an open-source publishing system that is particularly valuable for instructors who want to create dynamic, interactive course materials. Whether you're developing lecture notes, assignments, or entire textbooks, Quarto provides a powerful, flexible platform that integrates code, data, and narrative, making it ideal for educational settings. It supports a variety of programming languages, including R, Python, Julia, and Observable JavaScript, enabling instructors to design course content that actively engages students through hands-on coding exercises and real-time data analysis.
 
 ```{figure} ../images/Quarto.gif
-:width: 500px
 :align: center
 :name: Convert R markdown assignments/labs with quarto to produce pdfs
 ```

diff --git a/technology/real-time-collaboration.md b/technology/real-time-collaboration.md
@@ -9,7 +9,6 @@ title: Real-Time Collaboration
 It was previously tested in the Stat 159 hub during Spring '22, however, it [corrupted notebooks and files](https://github.com/jupyterlab/jupyterlab/issues/12154) and was disabled shortly after. It was also tried in the Data 100 hub in Summer '23, but a subset of users were [periodically affected](https://github.com/jupyterlab/jupyterlab/issues/14031) by RTC errors.
 
 ```{figure} ../images/rtc_issue.png
-:width: 500px
 :align: center
 :name: Data 100 RTC screenshot
 
@@ -48,7 +47,6 @@ shared with your collaborators:
 - Select "Copy Link" option which copies the link to your clipboard
 
 ```{figure} ../images/Share_link.gif
-:width: 500px
 :align: center
 :name: Shareable Link
 
@@ -61,7 +59,6 @@ Share this link with your collaborators. They will be able to access your notebo
 You can also see the cursors from other users with an anonymous username, a username that will disappear in a few seconds to make room for what is essential, the document’s content.
 
 ```{figure} ../images/RTC_demo.gif
-:width: 500px
 :align: center
 :name: RTC Demo
 

diff --git a/technology/remote-desktop.md b/technology/remote-desktop.md
@@ -11,9 +11,8 @@ operating in their DataHub home directories.
 Try remote desktop on [EECS DataHub](https://eecs.datahub.berkeley.edu/hub/user-redirect/desktop) with a berkeley.edu account, or [on Binder](https://mybinder.org/v2/gh/yuvipanda/jupyter-desktop-server/master?urlpath=desktop) without a berkeley.edu account.
 
 ```{figure} ../images/desktop.png
-:width: 500px
 :align: center
-:name: Shiny Demo
+:name: Remote Desktop screenshot
 
 Example of image processing with Qt in remote desktop
 ```
diff --git a/technology/rstudio.md b/technology/rstudio.md
@@ -5,7 +5,6 @@ title: RStudio
 [RStudio](https://posit.co/products/open-source/rstudio) is an integrated development environment that is popular among R users.
 
 ```{figure} ../images/rstudio.png
-:width: 500px
 :align: center
 :name: RStudio
 

diff --git a/technology/shiny.md b/technology/shiny.md
@@ -7,7 +7,6 @@ interactive web apps. R shiny server in DataHub is used to build interactive
 dashboards.
 
 ```{figure} ../images/shiny_combined.gif
-:width: 500px
 :align: center
 :name: Shiny demo on DataHub
 
@@ -40,7 +39,6 @@ Shiny launcher button.
 ## Example
 
 ```{figure} ../images/shinyDashboard.PNG
-:width: 500px
 :align: center
 :name: Shiny Dashboard
 
@@ -50,7 +48,6 @@ Explore Shiny Dashboard
 You can also view the code that generated the dashboard in the rendered output. 
 
 ```{figure} ../images/shinycode.PNG
-:width: 500px
 :align: center
 :name: Code for Shiny