chore: [FC-0074] drop hooks docs in favor of latest in docs.openedx.org

[mariajgrimaldi]

Description

This PR drops the docs/guides/hooks folder in favor of https://docs.openedx.org/en/latest/developers/concepts/hooks_extension_framework.html to centralize the framework's shared documents in docs.openedx.org and specific docs in each of their repositories for easier maintenance.

This PR doesn't replace the indexes in, for example, https://github.com/openedx/edx-platform/pull/35921/files#diff-4a76dd8b9b36530b1932c6b3145741031756e518f1a9d24abe6369082351059b but will be addressed in a different PR.

[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/wg-maintenance-edx-platform. 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.

[robrap]

Thanks.

[robrap]

Also, I think @feanil has added redirects for deleted docs in certain cases. That may be an option, but you are in a better position to determine whether it is worth it.

[sarina]

I think redirects would be good, @feanil if you can let us know the best way to do that

[feanil]

We use sphinx-reredirects for setting up redirects, they can be added to the conf.py : https://documatt.com/sphinx-reredirects/usage.html

[mariajgrimaldi]

Will do. Thank you!

[mariajgrimaldi]

Here's the suggested change: d3b3787. I can't ensure whether this configuration works correctly, so I'm generating docs locally to check. Thank you!

[mariajgrimaldi]

Do you know if there's a way to build these docs remotely? I'm not sure either if there's a way of testing these redirects independently without building the entire docs. It took an hour for my computer to kill the building process because it ran out of memory. I'm currently using the latest changes in master which fix the issues with sphinx resource consumption, but still :/

[feanil]

There is an issue currently that is causing the docs build to fail that @irtazaakram is looking at. Hopefully that will be fixed soon and you'll be able to build locally.

[mariajgrimaldi]

Thanks, @feanil! I could build the docs locally to test this out. Here's what I tested:

/hooks -> redirects to the new hooks docs
/hooks/events.html -> redirects to the new events docs
/hooks/filters.html -> redirects to the new filters docs

However, references to :doc:hooks/index won't work/ I'm guessing because those documents with the metadata to redirect are available after building, so sphinx doesn't find them. Instead, I added references to the new URLs here: 7e50063

[feanil]

I think that's fine for now, it looks like we don't have intersphinx setup to connect between this and the upstream docs so I think this can merge as is.

[mariajgrimaldi]

Thank you all!

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.