New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: new COURSE_CATALOG_INFO_CHANGED signal for course_authoring #81
Conversation
bd987fc
to
60a4b98
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice. Lots of minor questions/comments that hopefully aren't too controversial.
Co-authored-by: Robert Raposa <rraposa@edx.org>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some questions (mostly because I'm not as familiar with this data as I should be).
@ormsbee @robrap After some discussion, I think our options are
Notes: @robrap 's order of preference is (3) then (1). This preference for (3) assumes we are able to get absolute uris from within Studio without too much headache and then strip down to a relative path in Discovery with a similarly small headache. He really doesn't like (2) because of the confusing nature of a bunch of optional fields. My order of preference is (1) then (3), though it's not a terribly strong preference and is mostly in service of getting this out quicker. I agree (2) has the potential to be very confusing and doesn't save that much work over (3). If (3) is quick, then I'm all for it, I'm just not sure how long it will take to determine if it's quick. I think both of us agree we can at least start with 1, and then when implementing the actual event in Studio determine if we could do 3 without much more effort. |
As far as I can tell, while it used to be possible to edit media in Studio, it is not possible any more. This would suggest all the various media fields sent over from the lms to discovery are legacy. We could turn on some temporary logging in discovery to see if it ever actually updates course media as a result of RCM to support this hypothesis. |
For posterity, the decision was to drop all the media fields since they are unused by course-discovery. See the deprecation ticket at openedx/public-engineering#160 . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm basically all set, other than resolving Dave's comments. Thank you.
org (str): course organization identifier | ||
number (str): course number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nit] org/number are in a different order here than in the attributes.
schedule_data (CourseScheduleData): scheduling information for the course | ||
short_description (str): one- or two-sentence course description (optional) | ||
effort (str): estimated level of effort in hours per week (optional). Kept as a str to align with the lms model. | ||
hidden (bool): whether the course is hidden from search (optional) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nit] hidden
uses (optional)
on a bool with a default, but invitation_only
does not.
hidden (bool): whether the course is hidden from search (optional) | |
hidden (bool): whether the course is hidden from search (optional) |
The eventual ADR around this event design ended up here: https://github.com/openedx/openedx-events/blob/main/docs/decisions/0009-course-catalog-info-changed-design.rst |
Description:
Adds a new OpenEdxPublicSignal to describe the changing of the catalog information for a course
Issue: #72
Reviewers:
Merge checklist:
Post merge:
finished.