feat: [FC-0074] add event trigger information in code annotations#443
feat: [FC-0074] add event trigger information in code annotations#443mariajgrimaldi merged 10 commits intomainfrom
Conversation
|
Thanks for the pull request, @mariajgrimaldi! This repository is currently maintained by @openedx/hooks-extension-framework. Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.
|
d843f90 to
8385cbe
Compare
174a52d to
8b6706a
Compare
|
I'm going to defer my review to @bmtcril since he knows a lot more about this than I do. |
8b6706a to
5b18728
Compare
bmtcril
left a comment
There was a problem hiding this comment.
Looks good to me once code-annotations is released
d1763ac to
301842b
Compare
301842b to
693efa6
Compare
bmtcril
left a comment
There was a problem hiding this comment.
For me this is good to go once code-annotations is updated!
|
@bmtcril: done! Thank you so much for all the help :) |
Description
This PR adds a new code annotation for events indicating where they are being triggered from, including the repository and source file. When rendered in the docs, a link redirects to a GH search with the source file and the event name.
Events without a triggering field are not being used in any service or are candidates for deprecation: #445
Supporting information
This PR addresses a concern raised by this PR removing hooks docs from edx-platform: openedx/openedx-platform#35921 (comment), where the table referencing where each event was triggered from was dropped.
This PR depends on: openedx/code-annotations#143
Testing instructions
You can review the changes here: https://docsopenedxorg--443.org.readthedocs.build/projects/openedx-events/en/443/reference/events.html
Deadline
None
Checklists
Check off if complete or not applicable:
Merge Checklist:
Post Merge:
finished.