WikiEduDashboard
WikiEduDashboard copied to clipboard
WikiEducationFoundation
Add admin-only Notes feature for courses
Current Behavior:
There is no way within the Dashboard for Wiki Education admins to record notes about courses they are supporting.
Desired Behavior:
There should be a way for an admin to edit a Notes field related to a course, see that existing notes are already present from the Home tab.
Related Files & Code:
It think the best option for implementing this would be to add a new CourseNote model and table, and use a single editable field to record the notes for a given course.
@ragesoss, for this feature on the Home tab, how about adding a button under Actions labeled 'Course notes,' as shown in the screenshot? Clicking on it would take the admin to a dedicated notes page, displaying existing notes and providing options to create new ones. Will something like this work?
I was imagining something a little more prominent, such as an icon in the course navbar next to the Get Help button, but I'll ask my colleague to have a look.
@Abishekcs - I think it would be easiest to use if it was in the upper right corner in the box with the "Greet Students" and "Mark as Reviewed" buttons.
@ragesoss - could we trim the explanatory text about the "Mark as Reviewed" button to something like "Not yet reviewed"? I'd prefer if that box didn't get much bigger, since as it currently is I can see it all without scrolling most of the time (and as absurd as it sounds, not having to scroll saves a non-trivial amount of time and effort, especially when you're looking at a large number of course pages at once.
@iramjohn Okay, I will move the button to the upper right corner.
@ragesoss about this part (Clicking on it will take the admin to a dedicated notes page, where they can view existing notes and create new ones) will this be okay, or something else?
@Abishekcs ideally, I think it ought to open a model rather than navigating to a different page. but if it's significantly easier to implement as a separate page, that's okay; it ought to be possible to switch the UI later.
@ragesoss For the notes feature, only the admin should be able to create them, and students should only be able to read them?
The notes are internal notes only intended for admins — either as reminders for the admin writing them, or to share information between admins.
@Abishekcs - I think it would be easiest to use if it was in the upper right corner in the box with the "Greet Students" and "Mark as Reviewed" buttons.
@ragesoss - could we trim the explanatory text about the "Mark as Reviewed" button to something like "Not yet reviewed"? I'd prefer if that box didn't get much bigger, since as it currently is I can see it all without scrolling most of the time (and as absurd as it sounds, not having to scroll saves a non-trivial amount of time and effort, especially when you're looking at a large number of course pages at once.
@ragesoss Regarding the admin note icon/button, if it were placed in the upper right corner along with the "Greet Students" and "Mark as Reviewed" buttons as mentioned by @iramjohn, then the admin note icon/button would only be accessible toWiki Ed Staff, not the admin. I am confused about this because in the UI, only Wiki Ed Staff have access to the upper right corner box. So, should the user be an admin and a Wiki Ed Staff or only admin to access the admin notes ? I hope my question is clear😅 .
@ragesoss and @iramjohn, could you please check this video and let me know if it works for the UI -
https://github.com/WikiEducationFoundation/WikiEduDashboard/assets/74126284/24f08d85-0de2-4416-b554-32707490bd50
@Abishekcs yes, your question is clear! I think the right way to handle this would be to change the condition for rendering AdminQuickActions to look for admin rather than staff, and then only render the 'Mark as Reviewed' and 'Greet students' buttons for staff. All staff will be admins, but some admins won't be assigned to the course (which is what isStaff is based on). The new feature should apply to all admins, but the other two buttons are specific to the people assigned to support that course.