-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
chore: [FC-0074] drop old docs in favor of latest in docs.openedx.org #35921
base: master
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think redirects would be good, @feanil if you can let us know the best way to do that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use sphinx-reredirects
for setting up redirects, they can be added to the conf.py
: https://documatt.com/sphinx-reredirects/usage.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do. Thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 :/
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.