-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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: fix redirect #16548
docs: fix redirect #16548
Conversation
(cherry picked from commit d86aaad)
@@ -201,7 +201,6 @@ const Redirects=[ | |||
}, | |||
{ | |||
"from": [ | |||
"/docs/latest/ingestion/flatten-json.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.
Are we able to keep this redirect, and remove the flatten-json md
file instead? That way, all the redirects would be kept in one place.
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.
It's a tradeoff. We keep it all in one place, but redirects done this way always go to /latest
since we didn't adopt Docusaurus's versioning feature. The one in the file will stay within the same version.
I don't have strong feelings about one over the other. Traditionally, I think we've just typically been fine with redirects always going to the latest version. So we can stick with tradition 🤣
"/docs/latest/ingestion/flatten-json.html", | ||
"/docs/latest/ingestion/transform-spec.html" | ||
"/docs/latest/ingestion/transform-spec.html", | ||
"/docs/latest/ingestion/flatten-json.html" | ||
], | ||
"to": "/docs/latest/ingestion/ingestion-spec" |
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.
Should we split this into two entries? Since the Markdown file redirected to /docs/latest/ingestion/data-formats
, we might want to keep that. But keep redirecting transform-spec
to ingestion-spec
.
Also, let's double-check the flatten-json redirection works as expected (maybe something is off, which would be why the markdown was added a couple of weeks ago?).
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.
Works for me 🦖
This deletes a markdown file in favor of the redirect file entry. Having both led to the following warning:
Having it doesn't break anything since it just gets ignored, but it's nice to get rid of a warning
Verify by running
npm run build/yarn build
, launching the site locally (like withhttp-server
) and verifying thatHOST:PORT/docs/latest/ingestion/flatten-json.html
redirects toingestion-spec
This PR has: