Skip to content

[Bugfix:CourseMaterials] Improve Course Materials Editor#12074

Merged
bmcutler merged 9 commits intomainfrom
course-materials-editor-refactor
Oct 9, 2025
Merged

[Bugfix:CourseMaterials] Improve Course Materials Editor#12074
bmcutler merged 9 commits intomainfrom
course-materials-editor-refactor

Conversation

@RyanStyron
Copy link
Contributor

@RyanStyron RyanStyron commented Sep 22, 2025

Why is this Change Important & Necessary?

Fixes #11589
In addition to the fix, there are design changes to the course materials editor to improve usability.

What is the New Behavior?

Initially, a course materials with content test/temp.txt would appear on the page as follows:
image
Subsequently, an instructor opening the editor would be presented with this view in which the "File Path / URL" field would display the entirety of the local path. While potentially useful, it largely contributes to the bug noted in the attached issue.
image

Now, the "File Path / URL" field has been renamed to "Directory" and only displays the directory-subdirectory(ies) path:
image
Further, including file extensions (via use of the . character), has been prohibited so that this functionality is exceptionally clear.
image

These features apply to course materials which are hyperlinks as well. The editor for the case where the material is a link has been changed so that the URL itself is higher up in the editor UI:
image

In totality, the course materials editor is more streamlined for instructors.

What steps should a reviewer take to reproduce or test the bug or new feature?

Automated Testing & Documentation

Other information

@codecov
Copy link

codecov bot commented Sep 22, 2025

Codecov Report

❌ Patch coverage is 15.15152% with 28 lines in your changes missing coverage. Please review.
✅ Project coverage is 21.68%. Comparing base (b4fa1ef) to head (4a5cb4d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##               main   #12074      +/-   ##
============================================
- Coverage     21.68%   21.68%   -0.01%     
- Complexity     9591     9598       +7     
============================================
  Files           268      268              
  Lines         36618    36624       +6     
  Branches        475      475              
============================================
+ Hits           7940     7941       +1     
- Misses        28207    28212       +5     
  Partials        471      471              
Flag Coverage Δ
autograder 21.39% <ø> (ø)
js 2.07% <ø> (ø)
migrator 100.00% <ø> (ø)
php 20.69% <15.15%> (-0.01%) ⬇️
python_submitty_utils 80.08% <ø> (ø)
submitty_daemon_jobs 90.72% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@Rkoester47 Rkoester47 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this new Course Materials feature in Firefox, Chrome and Edge and it seems to be fully functional. In all three browsers, I tested moving an existing file between existing directories, uploading a new file, creating a new directory, and also made sure to try using the '.' character when creating a new directory. The UI looks clean and the new labels for text fields are clear and intuitive.

In all three browsers, the feature works as intended. This new change makes the experience much more streamlined and clear. Also, the warning pop up is a useful touch, that really does help highlight and clarify the update. The warning pop up worked in each browser tested in.

I think this is a solid change that will improve clarity and usability, while fixing a known issue with this area of the site.

@github-project-automation github-project-automation bot moved this from Seeking Reviewer to Awaiting Maintainer Review in Submitty Development Sep 22, 2025
Copy link
Contributor

@lavalleeale lavalleeale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested locally and the new changes look good to me, as well I reviewed the code and while I am not familiar with course materials I see no flaws

@github-project-automation github-project-automation bot moved this from In Review to Awaiting Maintainer Review in Submitty Development Oct 7, 2025
Copy link
Contributor

@JManion32 JManion32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good and has sufficient error checking / feedback for the user. The UI is more intuitive as well. Overall, this change significantly improves the user experience of the Course Materials page. Great work!

@bmcutler bmcutler merged commit 6a1d195 into main Oct 9, 2025
23 of 25 checks passed
@bmcutler bmcutler deleted the course-materials-editor-refactor branch October 9, 2025 04:06
@github-project-automation github-project-automation bot moved this from Awaiting Maintainer Review to Done in Submitty Development Oct 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Course material edits with path can't change the file name

5 participants