Add redirects for relocated docs #10221
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/10221
Note: Links to docs will display an error until the docs builds have been completed. ❌ 1 Cancelled JobAs of commit 98cef60 with merge base ae2d822 ( CANCELLED JOB - The following job was cancelled. Please retry:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
GregoryComer
added
topic: not user facing
module: doc
|
@pytorchbot cherry-pick --onto release/0.6 -c docs |
### Summary We've moved a number of doc pages in 0.6. This PR adds the sphinx-reredirects extension, which adds a sphinx feature to define redirected doc pages. I've used this to declare redirects for key relocated doc pages to preserve SEO and incoming external links. Solves #8728. ### Test plan I've locally built and served the docs and navigated to each of the redirected URLs. I confirmed that all redirect as expected. cc @mergennachin @byjlw (cherry picked from commit 47fb157)
Cherry picking #10221The cherry pick PR is at #10241 The following tracker issues are updated: Details for Dev Infra teamRaised by workflow job |
| "build-run-coreml": "backends-coreml.html", | ||
| "build-run-mediatek-backend": "backends-mediatek.html", | ||
| "build-run-mps": "backends-mps.html", | ||
| "build-run-qualcomm-ai-engine-direct-backend": "backends-qualcomm.html", | ||
| "build-run-xtensa": "backends-cadence.html", | ||
| "apple-runtime": "using-executorch-ios.html", |
There was a problem hiding this comment.
Not sure we have any of these left
There was a problem hiding this comment.
Yeah, the goal of this change is to make these old links point to the new pages. That way any external links (and SEO) will continue to work. I.e. if some other website links to the old "/build-run-coreml.html" page, it will auto-redirect to"/backends-coreml.html" and not be broken.
| @@ -195,6 +196,24 @@ | |||
| "torch": ("https://pytorch.org/docs/stable/", None), | |||
| } | |||
|
|
|||
| # Redirects for moved pages | |||
| redirects = { | |||
There was a problem hiding this comment.
Perhaps a simple find\replace would work as well?
| "build-run-qualcomm-ai-engine-direct-backend": "backends-qualcomm.html", | ||
| "build-run-xtensa": "backends-cadence.html", | ||
| "apple-runtime": "using-executorch-ios.html", | ||
| "tutorials/devtools-integration-tutorial": "../using-executorch-troubleshooting.html", |
There was a problem hiding this comment.
I don't think this is correct. original path is correct, it will not show up until running tutorial_source/devtools-integration-tutorial.py. Let me fix that in my PR.
There was a problem hiding this comment.
@Gasoonjia Can you explain more what you mean? I did manually test all of the redirected links and they worked as expected.
There was a problem hiding this comment.
yes your redirection is working, but the page you redirect to is not the one we need.
this is the one you redirected to: https://pytorch.org/executorch/0.6/using-executorch-troubleshooting.html
but this is the one we need: https://pytorch.org/executorch/0.6/tutorials/devtools-integration-tutorial.html
There was a problem hiding this comment.
Sure. Feel free to update the redirect link if you prefer that page.
### Summary We've moved a number of doc pages in 0.6. This PR adds the sphinx-reredirects extension, which adds a sphinx feature to define redirected doc pages. I've used this to declare redirects for key relocated doc pages to preserve SEO and incoming external links. Solves pytorch#8728. ### Test plan I've locally built and served the docs and navigated to each of the redirected URLs. I confirmed that all redirect as expected. cc @mergennachin @byjlw
Summary
We've moved a number of doc pages in 0.6. This PR adds the sphinx-reredirects extension, which adds a sphinx feature to define redirected doc pages. I've used this to declare redirects for key relocated doc pages to preserve SEO and incoming external links.
Solves #8728.
Test plan
I've locally built and served the docs and navigated to each of the redirected URLs. I confirmed that all redirect as expected.
cc @mergennachin @byjlw