-
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 hooks docs in favor of latest in docs.openedx.org #35921
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
616c95e
chore: drop old docs in favor of latest in docs.openedx.org
mariajgrimaldi 9d4494e
refactor: reference latest hooks documentation
mariajgrimaldi 46cda1c
docs: add reference to each repo docs
mariajgrimaldi 0a196cc
docs: add redirects for moved pages to avoid not found inconvenients
mariajgrimaldi 6f923d1
fix: address quality issues
mariajgrimaldi 7e50063
fix: reference new docs for hooks in index
mariajgrimaldi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 theconf.py
: https://documatt.com/sphinx-reredirects/usage.htmlThere 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 :/
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.
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.
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, @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
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 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.