diff --git a/.github/workflows/a11y.yml b/.github/workflows/a11y.yml index dd2233f..6490b2b 100644 --- a/.github/workflows/a11y.yml +++ b/.github/workflows/a11y.yml @@ -6,8 +6,6 @@ on: env: PRODUCTION_URL: "https://ds100.org/debugging-guide/" - # must match the end of PRODUCTION_URL - # leave blank if at root SITE_SUBDIR: "debugging-guide" jobs: @@ -15,44 +13,18 @@ jobs: runs-on: ubuntu-latest steps: - # 1. Checkout Code - name: Checkout repository uses: actions/checkout@v4 - # 2. Setup Quarto with TinyTex - - name: Set up Quarto - uses: quarto-dev/quarto-actions/setup@v2 - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - tinytex: true - - # 3. Setup Node.js (for Axe and http-server) + # Setup Node.js and install Axe and http-server - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '20' - - # 4. Setup Python - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: '3.11.9' - cache: 'pip' - - # 5. Install Python dependencies - - name: Install Python dependencies - run: pip install -r requirements.txt - - # 6. Render the Site - - name: Render Quarto Site - run: quarto render - - # 7. Install Tools - name: Install Axe and Server run: npm install -g @axe-core/cli http-server - # 8. Start Local Server (Background Process) + # Start Local Server - name: Start Local Server run: | # Mimic the production path structure exactly with @@ -65,7 +37,7 @@ jobs: sleep 5 - # 9. Run Axe Scan + # Run Axe Scan - name: Run Accessibility Scan id: axe-scan run: | @@ -86,7 +58,7 @@ jobs: --save axe-report.json \ --exit - # 10. Upload Report (Runs even if previous step fails) + # Upload Report even if previous step fails - name: Upload Accessibility Report if: always() uses: actions/upload-artifact@v4 diff --git a/README.md b/README.md index b759a4c..4ca53ee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Debugging Guide -[![Accessibility Checks](https://github.com/DS-100/debugging-guide/actions/workflows/a11y.yml/badge.svg)](https://github.com/DS-100/debugging-guide/actions/workflows/a11y.yml) +[![pages-build-deployment](https://github.com/DS-100/debugging-guide/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/DS-100/debugging-guide/actions/workflows/pages/pages-build-deployment) [![Accessibility Checks](https://github.com/DS-100/debugging-guide/actions/workflows/a11y.yml/badge.svg)](https://github.com/DS-100/debugging-guide/actions/workflows/a11y.yml) Website link: https://ds100.org/debugging-guide/ @@ -42,7 +42,7 @@ pip3 install -r requirements.txt # will take a while ipython kernel install --user ``` -If you get an `error: externally-managed-environment` on the third line, run `pip3 install -r requirements.txt --break-system-packages` +If you get an `error: externally-managed-environment` on the third line, run `pip3 install -r requirements.txt --break-system-packages`. You may also run into issues if you're running on Apple silicon. I fixed this by running `conda install -c conda-forge scikit-learn==1.2.2 scikit-image==0.25.2` before `pip3 install -r requirements.txt`. Remember to always activate the right environment before running anything with `conda activate data100quarto`. @@ -95,9 +95,11 @@ A pdf view of how this notebook renders in Quarto can be found [here](https://dr To give you the most control when inserting images, we use html with the following format to center images/figs and control their size: -```
``` +```
alt text here
``` -For example, `
`. +For example, `
description of image
`. + +In some instances, the images may be completely described in the text of the page. In these cases, you may leave the alt text blank i.e. `alt=""`. BUT THE ALT TEXT MUST STILL BE INCLUDED. ## Generating Output + Rendering Website diff --git a/_quarto.yml b/_quarto.yml index e763559..fc919a5 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -1,44 +1,48 @@ project: - type: book + type: website output-dir: docs -book: +website: site-url: "https://ds100.org/debugging-guide/" + page-footer: + center: + - text: Accessibility + href: "https://dap.berkeley.edu/get-help/report-web-accessibility-issue" + - text: Nondiscrimination + href: "https://ophd.berkeley.edu/policies-and-procedures/nondiscrimination-policy-statement" favicon: data100_logo.png title: "Data 100 Debugging Guide" image: data100_logo.png - author: ["Yash Dave", "Lillian Weng", "Wesley Zheng", "Emrie Loh"] repo-url: https://github.com/DS-100/debugging-guide search: location: sidebar type: textbox - chapters: - - index.md - - jupyter101/jupyter101.md - - jupyter_datahub/jupyter_datahub.md - - autograder_gradescope/autograder_gradescope.md - - pandas/pandas.md - - regex/regex.md - - visualizations/visualizations.md - - projA1/projA1.md - - projA2/projA2.md - - sql/sql.md - sidebar: logo: "data100_logo.png" + style: "docked" + title: "Data 100 Debugging Guide" + logo-alt: "Data 100 logo" + tools: + - icon: github + href: https://github.com/DS-100/debugging-guide + contents: + - index.md + - jupyter101/jupyter101.md + - jupyter_datahub/jupyter_datahub.md + - autograder_gradescope/autograder_gradescope.md + - pandas/pandas.md + - regex/regex.md + - visualizations/visualizations.md + - projA1/projA1.md + - projA2/projA2.md + - sql/sql.md format: html: - theme: cosmo + theme: cosmos toc: true toc-depth: 5 toc-expand: 3 # depth to expand index callout-icon: false number-sections: false - pdf: default -# navbar: -# search: false -# right: -# - icon: github -# href: https://github.com/ -# aria-label: GitHub -# - icon: arrows-fullscreen + include-after-body: + - a11y-fixes.html diff --git a/a11y-fixes.html b/a11y-fixes.html new file mode 100644 index 0000000..4235e03 --- /dev/null +++ b/a11y-fixes.html @@ -0,0 +1,36 @@ + \ No newline at end of file diff --git a/autograder_gradescope/autograder_gradescope.md b/autograder_gradescope/autograder_gradescope.md index 6d3f47b..31efb7b 100644 --- a/autograder_gradescope/autograder_gradescope.md +++ b/autograder_gradescope/autograder_gradescope.md @@ -2,14 +2,8 @@ title: Autograder and Gradescope / Pensieve format: html: - toc: true - toc-depth: 5 toc-location: right code-fold: false - theme: - - cosmo - - cerulean - callout-icon: false jupyter: jupytext: text_representation: @@ -34,16 +28,16 @@ jupyter: When you pass a test, you'll see a nice message and a cute emoji! -
+
Screenshot of a grader cell for question q2a with cell ouput 'q2a passed'
When you don't, however, the message can be a little confusing. -
+
Example of a cell output for a failing autograder test showing what test failed, what the code that was evaluated was, the expected output, and an error that was raised during the course of the test.

The best course of action is to find the test case that failed and use that as a starting point to debug your code. -
+
An annotated version of the previous image which includes the note 'The most useful error message is usually at the bottom'
In the example above, we see that the test case in green, `max_swing in set(bus['name'])`, is not passing. The actual output (in blue) is often hard to parse, so the best course of action is to: @@ -100,11 +94,11 @@ This can happen if you import external packages when you are not instructed to d If your Gradescope submission page has been stuck running on this page for a while: -
+
Autograder Results. The autograder hasn't finish running yet.
or if it times out: -
+
Autograder Results. In a red box 'The autograder failed to respond in the expected amount of time. If the autograder continues to fail, contact your course staff for help in debugging this issue. Make sure to include a link to this page so they can help you most effectively.'
it means that the Gradescope autograder failed to execute in the expected amount of time. TThis could be due to an inefficiency in your code or an issue on Gradescope's end, so we recommend resubmitting and allowing the autograder to rerun. If the issue persists after a few attempts, you may need to investigate your code for inefficiencies. diff --git a/docs/Data-100-Debugging-Guide.pdf b/docs/Data-100-Debugging-Guide.pdf deleted file mode 100644 index fba6adc..0000000 Binary files a/docs/Data-100-Debugging-Guide.pdf and /dev/null differ diff --git a/docs/autograder_gradescope/autograder_gradescope.html b/docs/autograder_gradescope/autograder_gradescope.html index eec2a59..53777d0 100644 --- a/docs/autograder_gradescope/autograder_gradescope.html +++ b/docs/autograder_gradescope/autograder_gradescope.html @@ -2,7 +2,7 @@ - + @@ -30,8 +30,6 @@ - - @@ -40,10 +38,10 @@ - + - + - + diff --git a/docs/index.html b/docs/index.html index f56a8e9..ddfffb9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,14 +2,10 @@ - + - - - - Data 100 Debugging Guide