You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "mistercrunch (via GitHub)" <gi...@apache.org> on 2024/04/28 00:51:38 UTC
[PR] docs: set up redirects [superset]
mistercrunch opened a new pull request, #28247:
URL: https://github.com/apache/superset/pull/28247
### 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.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: set up redirects [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch commented on PR #28247:
URL: https://github.com/apache/superset/pull/28247#issuecomment-2081273014
Unclear how much better are server-side redirects for this purpose, but search engines may do better with a clear permanent redirect (http 301)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: set up redirects [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch commented on PR #28247:
URL: https://github.com/apache/superset/pull/28247#issuecomment-2083102452
In terms of preventing dead link while allowing us to do more of these much needed refactors, I see two options:
- rigor and caution in docs PR reviews, make sure all orphaned routes are rewired some place
- set up some automation that prevents dead link. While working with the redirect plugin, I noticed it'll check and complain when there's a redirect to a link that's unknown to docusaurus. That means we could we could set up dummy redirect to every single existing route that would fail the build when becoming orphaned
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: set up redirects [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on PR #28247:
URL: https://github.com/apache/superset/pull/28247#issuecomment-2083130949
Failing the build upon a broken link seems reasonable to me and more likely to succeed than diligent reviews.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: set up redirects [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on code in PR #28247:
URL: https://github.com/apache/superset/pull/28247#discussion_r1583190927
##########
docs/docusaurus.config.js:
##########
@@ -135,6 +135,34 @@ const config = {
to: '/docs/faq',
from: '/docs/frequently-asked-questions',
},
+ {
+ to: '/docs/installation/kubernetes',
+ from: '/docs/installation/running-on-kubernetes/',
+ },
+ {
+ to: '/docs/contributing/howtos',
+ from: '/docs/contributing/testing-locally/',
+ },
+ {
+ to: '/docs/using-superset/creating-your-first-dashboard',
+ from: '/docs/creating-charts-dashboards/creating-your-first-dashboard/',
+ },
+ {
+ to: '/docs/using-superset/creating-your-first-dashboard',
+ from: '/docs/creating-charts-dashboards/exploring-data/',
+ },
+ {
+ to: '/docs/quickstart',
+ from: '/docs/installation/installing-superset-using-docker-compose/',
+ },
+ {
+ to: '/docs/contributing/howtos',
+ from: '/docs/contributing/creating-viz-plugins/',
+ },
+ {
+ to: '/docs/installation/kubernetes',
+ from: '/docs/installation/',
+ },
],
Review Comment:
```suggestion
{
to: '/docs/installation/pypi',
from: '/docs/installation/installing-superset-from-pypi/',
},
{
to: '/docs/configuration/configuring-superset',
from: '/docs/installation/configuring-superset/',
},
{
to: '/docs/configuration/cache',
from: '/docs/installation/cache/',
},
{
to: '/docs/configuration/async-queries-celery',
from: '/docs/installation/async-queries-celery/',
},
{
to: '/docs/configuration/event-logging',
from: '/docs/installation/event-logging/',
},
],
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: set up redirects [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch commented on PR #28247:
URL: https://github.com/apache/superset/pull/28247#issuecomment-2081272735
Ok looks like this work, there may be more dead links indexed, but should cover the first few pages of google results when googling `apache superset documentation`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: set up redirects [superset]
Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on code in PR #28247:
URL: https://github.com/apache/superset/pull/28247#discussion_r1583170907
##########
docs/docusaurus.config.js:
##########
@@ -135,6 +135,34 @@ const config = {
to: '/docs/faq',
from: '/docs/frequently-asked-questions',
},
+ {
+ to: '/docs/installation/kubernetes',
+ from: '/docs/installation/running-on-kubernetes/',
+ },
+ {
+ to: '/docs/contributing/howtos',
+ from: '/docs/contributing/testing-locally/',
+ },
+ {
+ to: '/docs/using-superset/creating-your-first-dashboard',
+ from: '/docs/creating-charts-dashboards/creating-your-first-dashboard/',
+ },
+ {
+ to: '/docs/using-superset/creating-your-first-dashboard',
+ from: '/docs/creating-charts-dashboards/exploring-data/',
+ },
+ {
+ to: '/docs/quickstart',
Review Comment:
```suggestion
to: '/docs/installation/docker-compose',
```
##########
docs/docusaurus.config.js:
##########
@@ -135,6 +135,34 @@ const config = {
to: '/docs/faq',
from: '/docs/frequently-asked-questions',
},
+ {
+ to: '/docs/installation/kubernetes',
+ from: '/docs/installation/running-on-kubernetes/',
+ },
+ {
+ to: '/docs/contributing/howtos',
+ from: '/docs/contributing/testing-locally/',
+ },
+ {
+ to: '/docs/using-superset/creating-your-first-dashboard',
+ from: '/docs/creating-charts-dashboards/creating-your-first-dashboard/',
+ },
+ {
+ to: '/docs/using-superset/creating-your-first-dashboard',
+ from: '/docs/creating-charts-dashboards/exploring-data/',
+ },
+ {
+ to: '/docs/quickstart',
+ from: '/docs/installation/installing-superset-using-docker-compose/',
+ },
+ {
+ to: '/docs/contributing/howtos',
+ from: '/docs/contributing/creating-viz-plugins/',
+ },
+ {
+ to: '/docs/installation/kubernetes',
+ from: '/docs/installation/',
+ },
],
Review Comment:
```suggestion
{
to: '/docs/installation/pypi/',
from: '/docs/installation/installing-superset-from-pypi/',
},
{
to: '/docs/configuration/configuring-superset/',
from: '/docs/installation/configuring-superset/',
},
{
to: '/docs/configuration/cache/',
from: '/docs/installation/cache/',
},
{
to: '/docs/configuration/async-queries-celery/',
from: '/docs/installation/async-queries-celery/',
},
{
to: '/docs/configuration/event-logging/',
from: '/docs/installation/event-logging/',
},
],
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: set up redirects [superset]
Posted by "mistercrunch (via GitHub)" <gi...@apache.org>.
mistercrunch merged PR #28247:
URL: https://github.com/apache/superset/pull/28247
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org