Standardize on DataHub.

There is currently a mix of DataHub and Datahub.
berkeley-cdss · Oct 7, 2024 · 1401c7d · 1401c7d
1 parent c1ba2a2
commit 1401c7d
Show file tree

Hide file tree

Showing 27 changed files with 72 additions and 72 deletions.
diff --git a/_toc.yml b/_toc.yml
@@ -57,12 +57,12 @@ parts:
   - file: workflow/download_notebook_as_pdf.md
     title: Download Jupyter Notebook as PDF
   - file: workflow/download-archive.md
-    title: Download Datahub home directory contents as archive
+    title: Download DataHub home directory contents as archive
   - file: workflow/performance_issue.md
     title: Best Practices to Avoid Performance Issues
   - file: workflow/calculate-compute-cost.ipynb
     title: Calculate GCP cost for compute intensive scenarios
-    sections: 
+    sections:
       - url: https://dev.datahub.berkeley.edu/user/balajialwar/voila/render/data100%20cloud%20cost%20calculator/data100_cloudcost_calculator.ipynb?
         title: "Launch Cloud Cost Calculator Widget"
   - file: workflow/securely-push-github
@@ -75,7 +75,7 @@ parts:
     title: Instructional Design Best Practices for Creating Jupyter Notebooks
   - file: faq/share
     title: Sharing information about the Hub
-- caption: Datahub Frequently Asked Questions (FAQ)
+- caption: DataHub Frequently Asked Questions (FAQ)
   chapters:  
   - file: faq/onboarding
     title: Onboard new users

diff --git a/faq/admin.md b/faq/admin.md
@@ -1,7 +1,7 @@
 # Accessing Elevated Privileges in a Hub
 
 ```{note}
-Curious about elevated privileges in Datahub? If yes, read below!
+Curious about elevated privileges in DataHub? If yes, read below!
 
 ```
 
@@ -21,7 +21,7 @@ Check this image to know your privileges for the admin option,
 ```{figure} ../images/admin.png
 :width: 500px
 :align: center
-:name: Datahub Admin
+:name: DataHub Admin
 
 Here is how the admin dashboard looks like!
 ```
@@ -38,8 +38,8 @@ To assign elevated privileges to a set of people other than all course staff, fo
 - In order to assign people to a group, they must have the role of "student". By default, course staff are either "teacher" or "ta", but they can be assigned more than one role. Visit the `People` section and click `+ People`. Specify the users' email addresses and make sure the Role is set to `Student`.
 - Create a [bcourses group](https://community.canvaslms.com/t5/Instructor-Guide/How-do-I-manually-create-groups-in-a-group-set/ta-p/700). The first step will be to create a groupset and then create a group inside it. For example, you can title the groupset "Staff Groups" and the group "Hub Admins".
 - [Add people to the created group](https://community.canvaslms.com/t5/Instructor-Guide/How-do-I-manually-assign-students-to-groups/ta-p/663).
-- Share the bcourses ID in the Github template. The admins will make changes to the Datahub configuration to enable this feature. If you are assigning privileges to a group of people other than course staff, specify this in the Github issue.
-- Once elevated privileges are assigned to jupyterhub groups based on the [Datahub documentation](https://docs.datahub.berkeley.edu/en/latest/admins/howto/course-config.html#assigning-scopes-to-roles), the people being granted those privileges will need to logout of the hub and then log in again for the config changes to persist. This is not the same thing as stopping and starting the server -- users need to click "Logout".
+- Share the bcourses ID in the Github template. The admins will make changes to the DataHub configuration to enable this feature. If you are assigning privileges to a group of people other than course staff, specify this in the Github issue.
+- Once elevated privileges are assigned to jupyterhub groups based on the [DataHub documentation](https://docs.datahub.berkeley.edu/en/latest/admins/howto/course-config.html#assigning-scopes-to-roles), the people being granted those privileges will need to logout of the hub and then log in again for the config changes to persist. This is not the same thing as stopping and starting the server -- users need to click "Logout".
 - You will be able to access the admin interface in the UI by navigating to "<Hub URL>/hub/admin" and check for the admin status of varied users. You will also be able to use the "Manage groups" option in the admin interface to check the bcourses id of courses with admin privileges.
 - Sometimes, users in your course might not be listed as part of the admin interface. During those circumstances, it is recommended that those users log out of the hub and then log back in. It might take sometime for those users to be listed as part of your admin view.
 
@@ -57,7 +57,7 @@ Please follow the steps below to navigate admin interface,
 ```{figure} ../images/adminaccess.PNG
 :width: 500px
 :align: center
-:name: Datahub Admin snapshot
+:name: DataHub Admin snapshot
 
 Here is where you can find admin option!
 ```
@@ -86,7 +86,7 @@ Here is how the control panel option looks like!
 ```{figure} ../images/adminaccess.PNG
 :width: 500px
 :align: center
-:name: Datahub Admin snapshot
+:name: DataHub Admin snapshot
 
 Here is where you can find admin option!
 ```

diff --git a/faq/changerequirements.md b/faq/changerequirements.md
@@ -28,7 +28,7 @@ install.packages("ggplot2")
 
 **How can I increase per-user RAM/CPU?**
 
-We recommend instructors to adapt the materials to the 1GB requirement of the Datahub as it is convenient for most usecases. However, If you have a compelling reason to request for more RAM/CPU, 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). Provide rationale for this upgrade as it has cost implications for the service.
+We recommend instructors to adapt the materials to the 1GB requirement of the DataHub as it is convenient for most usecases. However, If you have a compelling reason to request for more RAM/CPU, 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). Provide rationale for this upgrade as it has cost implications for the service.
 
 There are three factors we consider as part of the requests related to increasing RAM:
 
@@ -56,7 +56,7 @@ CPU grant requests are more complex as they they are more likely to affect perfo
 
 **As an instructor, What should I do if I want to conduct a workshop? Are there any existing hubs that I could repurpose?**
 
-Yes. We certainly do support using our hubs for workshops. For example, [D-Lab](https://dlab.berkeley.edu/) uses Datahub to run its R workshops for students regularly.
+Yes. We certainly do support using our hubs for workshops. For example, [D-Lab](https://dlab.berkeley.edu/) uses DataHub to run its R workshops for students regularly.
 
 Please send an email to Eric Van Dusen ([email protected])/Balaji Alwar ([email protected]) with the specific request you have in mind. 
 
@@ -92,7 +92,7 @@ Most of the issues with the dataset arise due to the programming practices used
 
 **What should I do If I want to switch from an existing hub to an R hub?**
 
-You can directly use the [R Datahub](http://r.datahub.berkeley.edu/) dedicated to serving courses using R. If you have other specific requirements, please do reach out to us.
+You can directly use the [R DataHub](http://r.datahub.berkeley.edu/) dedicated to serving courses using R. If you have other specific requirements, please do reach out to us.
 
 **When can I create a new hub?**
 

diff --git a/faq/features.md b/faq/features.md
@@ -7,9 +7,9 @@ Have suggestions on new ways to improve our offering? If yes, read below!
 
 **How do I raise a new requirement for the hub?**
 
-We are always open to new ways of supporting the campus community using Datahub. If you have a new requirement, Raise a new GitHub issue using this [link](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=type%3A+enhancement&template=featurerequest.md). Follow the steps outlined as part of the template to make a case for this enhancement.
+We are always open to new ways of supporting the campus community using DataHub. If you have a new requirement, Raise a new GitHub issue using this [link](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=type%3A+enhancement&template=featurerequest.md). Follow the steps outlined as part of the template to make a case for this enhancement.
 
-**Where will I get updates/notifications about the Datahub feature releases?**
+**Where will I get updates/notifications about the DataHub feature releases?**
 
 We are trying to build a cadence by sending public announcements about feature releases or version upgrades in the upcoming months. So do watch out for emails from the datahub-announce list!
 
@@ -23,4 +23,4 @@ We don't have options to collaborate with other users using any of our hubs at t
 
 **How can I contribute to the open source community building this tool?**
 
-Thanks for thinking about contributing to this amazing community. Reach out to us! You can get a sense of how to contribute to Datahub by reading this [link](https://docs.datahub.berkeley.edu/en/latest/admins/pre-reqs.html).
+Thanks for thinking about contributing to this amazing community. Reach out to us! You can get a sense of how to contribute to DataHub by reading this [link](https://docs.datahub.berkeley.edu/en/latest/admins/pre-reqs.html).
diff --git a/faq/jupyterhub-intro.md b/faq/jupyterhub-intro.md
@@ -1,4 +1,4 @@
-# Datahub Frequently Asked Questions
+# DataHub Frequently Asked Questions
 
 ```{note}
 This FAQ section highlights some of the commonly asked questions while setting up and running Jupyterhubs. 

diff --git a/faq/onboarding.md b/faq/onboarding.md
@@ -1,6 +1,6 @@
 # Get yourself onboarded to DataHub
 
-**I am instructor planning to teach using Datahub. What should I know prior to the start of the semester?**
+**I am instructor planning to teach using DataHub. What should I know prior to the start of the semester?**
 
 
 ##### General Updates
@@ -15,7 +15,7 @@
 
 **Using Language Models in Assignments:** If you plan to incorporate language models into your assignments then please schedule a consultation with the infra team before releasing the assignments to students. For more details, please refer to the [documentation](https://ds-modules.github.io/curriculum-guide/technology/using-ai-llm.html).
 
-**Datahub Link Generator:** A Berkeley specific fork of nbgitpuller browser extension called [“Datahub Link Generator”](https://chromewebstore.google.com/detail/datahub-link-generator/ijbgangngghdanhcnaliiobbiffocahf?hl=en) has been developed with few additional features. Please uninstall the old extension and reinstall the [latest version](https://chromewebstore.google.com/detail/datahub-link-generator/ijbgangngghdanhcnaliiobbiffocahf?hl=en) in Chrome so that you can get the recent updates and support. We encourage you to review this [documentation](https://ds-modules.github.io/curriculum-guide/workflow/distributing-notebooks.html#datahub-link-generator-chrome-extension) which provides detailed steps to generate assignment links through the new extension.
+**DataHub Link Generator:** A Berkeley specific fork of nbgitpuller browser extension called [“DataHub Link Generator”](https://chromewebstore.google.com/detail/datahub-link-generator/ijbgangngghdanhcnaliiobbiffocahf?hl=en) has been developed with few additional features. Please uninstall the old extension and reinstall the [latest version](https://chromewebstore.google.com/detail/datahub-link-generator/ijbgangngghdanhcnaliiobbiffocahf?hl=en) in Chrome so that you can get the recent updates and support. We encourage you to review this [documentation](https://ds-modules.github.io/curriculum-guide/workflow/distributing-notebooks.html#datahub-link-generator-chrome-extension) which provides detailed steps to generate assignment links through the new extension.
 
 **Backup Students' Data:** We recommend that you inform students to back up their data (notebooks and datasets) on their local devices before the end of the semester. We have prepared [download instructions](https://ds-modules.github.io/curriculum-guide/workflow/download-archive.html) on how students can retrieve all of their archived files.  We receive a lot of student requests to retrieve their files after the completion of the semester. Any upfront communication from your end about backing up their files will hopefully ease the workload for us.
 
@@ -27,9 +27,9 @@
 
 **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 Service Lead:** In addition, you can reach out to Balaji Alwar <[email protected]> directly if there are time-sensitive issues.
 
-##### Datahub - Common Requests 
+##### 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](https://ds-modules.github.io/curriculum-guide/faq/admin.html?highlight=admin) for course staff to troubleshoot student servers in the requested hub. 
@@ -44,17 +44,17 @@
 
 Finally, provide us with any feedback that will help us improve our hub operations. We want to ensure that you have a smooth experience teaching this semester.
 
-**How can I learn more about Datahub to onboard myself?**
+**How can I learn more about DataHub to onboard myself?**
 
-- If you are new to Datahub and want to know more, checkout [here](https://datahub.berkeley.edu/hub/login?next=%2Fhub%2F). 
+- If you are new to DataHub and want to know more, checkout [here](https://datahub.berkeley.edu/hub/login?next=%2Fhub%2F). 
 
 - If you are interested in learning more about the configuration of various Berkeley hubs, you can checkout [UC Berkeley's JupyterHubs documentation](https://docs.datahub.berkeley.edu/en/latest/).
 
 - If you want to set up a hub infrastructure at your end and are interested in learning more about the technical details, use this [Zero to JupyterHub with Kubernetes documentation](https://zero-to-jupyterhub.readthedocs.io/en/latest/).
 
 **What languages are supported by the hub?**
 
-Datahub primarily supports three languages - **Python, R and, Julia**. However, We also support other languages on a case-to-case basis. If you have a unique requirement for using a different programming language as part of your hub, Share your exact requirement over an email to [Eric Van Dusen](mailto:[email protected])/[Balaji Alwar](mailto:[email protected]) or raise a Github [issue](https://github.com/berkeley-dsep-infra/datahub/issues/new/choose).
+DataHub primarily supports three languages - **Python, R and, Julia**. However, We also support other languages on a case-to-case basis. If you have a unique requirement for using a different programming language as part of your hub, Share your exact requirement over an email to [Eric Van Dusen](mailto:[email protected])/[Balaji Alwar](mailto:[email protected]) or raise a Github [issue](https://github.com/berkeley-dsep-infra/datahub/issues/new/choose).
 
 **How many hubs across the campus exist? Which courses use them extensively?**
 
@@ -118,10 +118,10 @@ If these templates are not exhaustive enough to cover the type of issue you are
 
 **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. 
+Honestly, nothing! You are free to use the DataHub starting today. 
 
 ```{note}
-We expect that all course members log in using their UC Berkeley email id. We also expect that you are using [Datahub Link Generator](https://chromewebstore.google.com/detail/datahub-link-a/ijbgangngghdanhcnaliiobbiffocahf?hl=en) to distribute materials to your class. We can also help with setting up the links. 
+We expect that all course members log in using their UC Berkeley email id. We also expect that you are using [DataHub Link Generator](https://chromewebstore.google.com/detail/datahub-link-a/ijbgangngghdanhcnaliiobbiffocahf?hl=en) to distribute materials to your class. We can also help with setting up the links. 
 ```
 
 **What instructions should I share with students at the start of the semester**
@@ -134,7 +134,7 @@ Please ask your students,
 
 We can’t allow non UC Berkeley users as our authentication system only allows users with UC Berkeley email id. For such users, there are couple of options we recommend below, 
 
-- Use the [Calnet Sponsored Guests](https://calnetweb.berkeley.edu/calnet-departments/calnet-sponsored-guests) option to get temporary access to bcourses which will allow you to access the Datahub service.
+- Use the [Calnet Sponsored Guests](https://calnetweb.berkeley.edu/calnet-departments/calnet-sponsored-guests) option to get temporary access to bcourses which will allow you to access the DataHub service.
 - Use [Binder](https://mybinder.org/) or [Jupyterlite](https://jupyterlite.readthedocs.io/en/stable/) services to solve for the immediate needs.
 
 **How do my students download their submissions as a PDF?**

diff --git a/faq/troubleshoot.md b/faq/troubleshoot.md
@@ -95,7 +95,7 @@ Sorry, that you had to face this error! This error could be due to some of our s
 
 Sorry, that you had to face this error! This error could be due to multiple reasons outlined below, 
 
-- You are using email id with a different domain other than berkeley.edu to authenticate with Datahub which could have potentially raised this error. Raise a github [issue](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=bug&template=bug_report.yml), so that we can authorize your domain.
+- You are using email id with a different domain other than berkeley.edu to authenticate with DataHub which could have potentially raised this error. Raise a github [issue](https://github.com/berkeley-dsep-infra/datahub/issues/new?assignees=&labels=bug&template=bug_report.yml), so that we can authorize your domain.
 
 - Large number of your students are trying to use the service resulting in failure of certain nodes. We are working on improving how we scale the hub with large volume of users.
 

diff --git a/general/people.md b/general/people.md
@@ -1,11 +1,11 @@
 # Who are we?
 
-Here are the people in involved with Datahub Infrastructure and Modules team
+Here are the people in involved with DataHub Infrastructure and Modules team
 
 | Name | Role |
 | :--- | :--- |
 | [Eric Van Dusen](mailto:[email protected]) | Tech and Outreach Lead at DSUS |
-| [Shane Knapp](mailto:[email protected]) | Technical Lead, Datahub Infrastructure |
+| [Shane Knapp](mailto:[email protected]) | Technical Lead, DataHub Infrastructure |
 | [Balaji Alwar](mailto:[email protected]) | Service Lead for JupyterHub Infrastructure 
 | [Ryan Lovett](mailto:[email protected]) | Manages JupyterHub Infrastructure |
 | [Jonathan Felder](mailto:[email protected]) | Manages JupyterHub Infrastructure |

diff --git a/intro.md b/intro.md
@@ -12,7 +12,7 @@ b) Students who are enrolled in courses using DataHub and want to learn about th
 The information is divided up into six sections:
 1. **Getting Started With the DataHub tools**: Guide to familiarize you with the DataHub platform and its essential tools.
 2. **Workflow Basics**: This section covers information around creating, distributing, and grading assignments.
-3. **Datahub Frequently Asked Questions (FAQ)**: Comprehensive FAQ section that addresses common questions and issues encountered by DataHub users.
+3. **DataHub Frequently Asked Questions (FAQ)**: Comprehensive FAQ section that addresses common questions and issues encountered by DataHub users.
 4. **Resources for Students**: Curated resources tailored for students enrolled in DataScience courses.
 5. **Getting Started With the Modules and Connectors**: An overview of the different Data Science Education course types.
 6. **Creating a Connector**: A guide to the pre-course set-up for a Connector course.