Skip to content

Commit

Permalink
Merge pull request #15 from ryanlovett/fix-links
Browse files Browse the repository at this point in the history
Fix old ds-modules links.
  • Loading branch information
ryanlovett authored Oct 8, 2024
2 parents 78ea825 + 0fbf4e8 commit 159dfac
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 145 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## The Guide has Moved!

This guide is now located at [ds-modules.github.io/curriculum-guide](https://ds-modules.github.io/curriculum-guide).
This guide is now located at [curriculum-guide.datahub.berkeley.edu](https://curriculum-guide.datahub.berkeley.edu).

### What is this guide and who is it for?

Expand Down Expand Up @@ -59,7 +59,7 @@ $ mkdir repos
$ cd repos
```

Next, go to the [Curriculum Guide github repo](https://github.com/ds-modules/curriculum-guide)
Next, go to the [Curriculum Guide github repo](https://github.com/berkeley-cdss/curriculum-guide)
and create a fork. To do this, click on the `fork` button and then
`Create fork`.

Expand All @@ -77,7 +77,7 @@ $ pwd

Now you can run the `git clone` command:
```
git clone [email protected]:ds-modules/curriculum-guide.git
git clone [email protected]:berkeley-cdss/curriculum-guide.git
```

Now `cd` in to `curriculum-guide` directory and set up your local repo
Expand All @@ -89,8 +89,8 @@ Here is an example, including output, of how to set up your remotes:
```
$ cd curriculum guide
$ git remote -v
origin [email protected]:ds-modules/curriculum-guide.git (fetch)
origin [email protected]:ds-modules/curriculum-guide.git (push)
origin [email protected]:berkeley-cdss/curriculum-guide.git (fetch)
origin [email protected]:berkeley-cdss/curriculum-guide.git (push)
$ git remote rename origin upstream
$ git remote add origin [email protected]:<your github username>/curriculum-guide.git
$ git remote -v
Expand Down Expand Up @@ -160,14 +160,14 @@ git push origin <branch name>
```

Once you've pushed to your fork, you can go to the
[Curriculum Guide repo](https://github.com/ds-modules/curriculum-guide)
[Curriculum Guide repo](https://github.com/berkeley-cdss/curriculum-guide)
and there should be a big green button on the top that says `Compare and pull request`.
Click on that, check out the commits and file diffs, edit the title and
description if needed and then click `Create pull request`.

Once you create a pull request, a github action will run which will build the
Once you create a pull request, a github action will run to build the
jupyterbook and publish it to
https://ds-modules.github.io/curriculum-guide/intro.html as a public facing
https://curriculum-guide.datahub.berkeley.edu/intro.html as a public facing
website. Github action will fail if there are issues with the commit.

# Recommended reading
Expand Down
117 changes: 0 additions & 117 deletions _config.yml

This file was deleted.

12 changes: 6 additions & 6 deletions faq/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@

**Test Assignments in Advance:** Please try to test assignments and notebooks on the hub before giving them to students. This will allow time for the infra team to fix any issues you discover.

**Export to PDF Using WebPDF:** We recommend using the “Save and Export Notebook as -> WebPDF” option to convert Jupyter notebooks to PDF. We have resolved the image rendering issues previously encountered with this method and are hoping for a smoother conversion process. For more details on PDF conversion, please refer to the [documentation](https://ds-modules.github.io/curriculum-guide/workflow/download_notebook_as_pdf.html).
**Export to PDF Using WebPDF:** We recommend using the “Save and Export Notebook as -> WebPDF” option to convert Jupyter notebooks to PDF. We have resolved the image rendering issues previously encountered with this method and are hoping for a smoother conversion process. For more details on PDF conversion, please refer to the [documentation](download_notebook_as_pdf).

**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).
**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](using-ai-llm).

**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](distributing-notebooks#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.
**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](download-archive) 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.

**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].

Expand All @@ -32,13 +32,13 @@
##### 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.
**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](https://ds-modules.github.io/curriculum-guide/workflow/accessibility.html?highlight=accessibility) that provides a few tips for improving the accessibility of the notebooks.
**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.

**JupyterLab a11y Checker:** Please check out the [JupyterLab a11y-checker extension](https://pypi.org/project/jupyterlab-a11y-checker/) that performs multiple accessibility checks on Jupyter notebook/Lab cells containing images and headings. It does the following, a) Verifies the presence of alt-text for images, ensuring that visually impaired users can understand their content, b) Calculates the colour contrast ratio to ensure readability for low-vision users and c) Evaluates the heading structure to align with WCAG standards, ensuring that headers (h1, h2, etc.) are appropriately structured for optimal accessibility.

Expand Down
7 changes: 0 additions & 7 deletions redirect.md

This file was deleted.

Loading

0 comments on commit 159dfac

Please sign in to comment.