docs: [FC-0074] add more detailed concepts on events

[mariajgrimaldi]

Description

This PR improves the concept section of the documentation by adding a new document dedicated only to Open edX Events.

Initially, I also added two additional modifications:

1. Update references in the Hooks Extension Framework document and explain why the framework should be adopted.
2. Adding a new document comparing Open edX Events vs Filters to ease adoption.

Which I later dropped in favor of centralizing shared documentation docs.openedx.org and avoiding duplication across repos: So I'll be moving those docs to docs.openedx.org, Here's the PR for the implementation: openedx/docs.openedx.org#599

For more details on the decision, please see this thread.

[openedx-webhooks]

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 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/hooks-extension-framework. Tag them in a comment and let them know that your changes are ready for review.

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.

[mariajgrimaldi]

@sarina @Apgomeznext: here's the WIP I've been working on for the 1.1 Improve Definitions and Update Outdated References in the Framework project feature.

I discussed with AnaP having feedback loops within the maintenance team about the documents' content. She'd get involved to review the document structure once she has the capacity for the project. So, early feedback is welcome.

[sarina]

Maybe have "Event Bus" link to documentation on the event bus?

[mariajgrimaldi]

Done: 6926b20#diff-982f9d143e6afcea5b84eeb1ea3c3fb5412239c1968359fab161cb4af58e9b63R62

But the only available docs we have to date about the event bus is a confluence document, so that's what I linked: https://openedx.atlassian.net/wiki/spaces/AC/pages/3508699151/How+to+start+using+the+Event+Bus. Once we move those documents here, I'll update the references.

[sarina]

I think it would be good to include some detail about how you don't need to modify code within the openedx github org to achieve this. Could we link out to some third-party examples?

[mariajgrimaldi]

Absolutely! I'm currently working on a list of use cases. In the next few hours, I'll link the PR here in this comment.

I'll link the PR here in this comment tomorrow.

[sarina]

Overall it Looks great now, I'll do a final review once these use cases are in

[mariajgrimaldi]

I haven't had the time to work on this. So I'll be on it today. Thank you for the patience!

[mariajgrimaldi]

Here's the PR with the use cases: #416