-
Notifications
You must be signed in to change notification settings - Fork 21
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: [FC-0074] add event trigger information in code annotations #443
base: main
Are you sure you want to change the base?
Conversation
Thanks for the pull request, @mariajgrimaldi! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
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. |
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/edx-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.