docs: [FC-0074] add note about decisions documented in each hooks repositories

[mariajgrimaldi]

Description

This PR adds notes about Open edX Events and Filters to event-driven-related OEPs and the Hooks Extension Framework OEP, specifying where to find architectural decisions about the framework. This PR addresses: openedx/openedx-events#438 (review)

[openedx-webhooks]

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @sarina.

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.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To 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:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

---

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[robrap]

Just some ideas to see what you both think.

[robrap]

Reading this gave me additional ideas that you may like or not like.

1. This reads like a small decision. I’m wondering if there could be a brief OEP that describes this decision named “Event Related Decision Records”, or “Event and Filter…” or “Hook, Event and Filter…” that details this change, and notes could point to this OEP?
2. Maybe this won’t be the last time we choose a library repo for housing OEP-esque ADRs on a topic? We could consider updating OEP-19 with this as an option, or an OEP-19 sub ADR, and also list all the current cases as an index.

These are just ideas, and they could influence how we add the notes. That said, we could make these notes the first iteration.

[sarina]

I disagree with this - I think that's adding too much process that no one will ultimately end up reading/needing. I think this note in the OEP is enough. I ran this by Feanil and Kyle and they agree with me, as well.

[robrap]

There may be more places that warrant this change, but “the repository” is vague and by default might mean “this repository”, but it doesn’t.

Suggested change

	2024-01-14: Added note about decisions related to Open edX Events being documented and made publicly available through the Architectural Decision Records (ADRs) in the repository.
	2024-01-14: Added note about decisions related to Open edX Events being documented and made publicly available through the Architectural Decision Records (ADRs) in the openedx-events repository.