[Bugfix:CourseMaterials] Improve Course Materials Editor#12074
[Bugfix:CourseMaterials] Improve Course Materials Editor#12074
Conversation
…se-materials-editor-refactor
Codecov Report❌ Patch coverage is Additional details and impacted files@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Rkoester47
left a comment
There was a problem hiding this comment.
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.
…se-materials-editor-refactor
…ialsController.php.
lavalleeale
left a comment
There was a problem hiding this comment.
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
JManion32
left a comment
There was a problem hiding this comment.
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!
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.txtwould appear on the page as follows: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.
Now, the "File Path / URL" field has been renamed to "Directory" and only displays the directory-subdirectory(ies) path:


Further, including file extensions (via use of the
.character), has been prohibited so that this functionality is exceptionally clear.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:

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