-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
docs: set up redirects #28247
docs: set up redirects #28247
Conversation
Someone filled an issue about search index referring to dead links in our documentation. Turns out many of the top links when googling `apache superset documentation` point to 404s now. In this PR I'm trying to set up client-side redirects to the related pages. Note that the docs for this plugin state that server-side redirects are better, and that the redirects don't work in dev, only prod, which makes it hard to test In the future, we'll need more rigor around catching dead links, either during code review for the docs, or through some docusaurus automation magic forcing us to come up with redirects whenever we kill routes.
Ok looks like this work, there may be more dead links indexed, but should cover the first few pages of google results when googling |
Unclear how much better are server-side redirects for this purpose, but search engines may do better with a clear permanent redirect (http 301) |
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.
Important fix to the docs, thank you. I went through this recent PR #28161 and added additional redirects where:
- The result was broken coming from a search engine, and
- It wasn't yet fixed in the file on your branch
Co-authored-by: Sam Firke <[email protected]>
Co-authored-by: Sam Firke <[email protected]>
In terms of preventing dead link while allowing us to do more of these much needed refactors, I see two options:
|
Failing the build upon a broken link seems reasonable to me and more likely to succeed than diligent reviews. |
Co-authored-by: Sam Firke <[email protected]>
Co-authored-by: Sam Firke <[email protected]>
SUMMARY
Someone filled an issue about search index referring to dead links in our
documentation. Turns out many of the top links when googling
apache superset documentation
point to 404s now.In this PR I'm trying to set up client-side redirects to the related pages.
Note that the docs for this plugin state that server-side redirects are
better, and that the redirects don't work in dev, only prod, which
makes it hard to test
In the future, we'll need more rigor around catching dead links,
either during code review for the docs, or through some docusaurus
automation magic forcing us to come up with redirects whenever we kill
routes.
Docusaurus redirect plugin documentation for reference
Testing
I took the freedom to run
gh workflow run superset-docs-deploy.yml -r docs_redirect
, logs here since there's no way to test in dev and wanted this fix asap.closes #28245