docs: [FC-0074] use glossary as reference material

[mariajgrimaldi]

Description

This PR:

1. Move glossary document to the reference section for better organization.
2. Use sphinx utilities to implement a glossary.
3. Reference glossary throughout all documents when needed.

[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 another PR part of the 1.1 Improve Definitions and Update Outdated References in the Framework implementation effort.

[sarina]

Are exceptions a recommended practice, or should they be avoided except in extreme cases?

[mariajgrimaldi]

We encourage using exceptions when it makes sense considering the use case of the filter. For example, the course enrollment filter has its own exceptions cause some developers might want to stop the enrollment process when a condition is met. But there are other filters, like changing the IDV URL during runtime, where raising an exception doesn't make much sense.

[sarina]

Sounds good - sounds pretty conditional, don't think another note needs to be made.

[sarina]

I think this could be explained a little better. But I may not get it right. Maybe,

Suggested change

Basically, we're testing the :term:`filter signature<Filter Signature>` and the filter's behavior for stopping the process. The first test is testing the :term:`filter signature<Filter Signature>`, which is the set of parameters that the filter receives and returns. The second test is testing the filter's behavior for stopping the process, which is the exception that is raised when the filter stops the process.

In this example, we're testing the :term:`filter signature<Filter Signature>` and the filter's behavior for stopping the process. The first test is testing the :term:`filter signature<Filter Signature>`, specifically that the behavior works as expected when passed mock form data. The second test is testing the filter's behavior for stopping the process, which is the exception that is raised when the filter stops the process.

I think the phrase " which is the set of parameters that the filter receives and returns" isn't needed, because we explain that in detail in the lines above the test.

[felipemontoya]

I think this glossary is correct. I was mostly looking at the content and did not review the format at all.

Left a minor comment from what looks like a missing word, nut otherwise good to merge