[SPARK-45098][DOCS] Custom jekyll-rediect-from redirect.html template to fix doc redirecting #42848
Conversation
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
srowen
approved these changes
Sep 8, 2023
dongjoon-hyun
approved these changes
Sep 8, 2023
There was a problem hiding this comment.
+1, LGTM. Thank you, @yaooqinn .
I verified locally that it has .html extension after this PR.
<link rel="canonical" href="http://localhost:4000/building-spark.html">
<script>location="http://localhost:4000/building-spark.html"</script>
<meta http-equiv="refresh" content="0; url=http://localhost:4000/building-spark.html">
dongjoon-hyun
pushed a commit
that referenced
this pull request
Sep 8, 2023
… to fix doc redirecting ### What changes were proposed in this pull request? In https://dist.apache.org/repos/dist/dev/spark/v3.5.0-rc4-docs/_site/, these links are supposed to redirect to the correct targets, but failed because there are no `.html` extensions. - [building-with-maven.html](https://dist.apache.org/repos/dist/dev/spark/v3.5.0-rc4-docs/_site/building-with-maven.html) ---> [building-spark.html](https://dist.apache.org/repos/dist/dev/spark/v3.5.0-rc4-docs/_site/building-spark.html) - [sql-reference.html](https://dist.apache.org/repos/dist/dev/spark/v3.5.0-rc4-docs/_site/sql-reference.html) ---> [sql-ref.html](https://dist.apache.org/repos/dist/dev/spark/v3.5.0-rc4-docs/_site/sql-ref.html) This PR customs the redirect template to add extensions to fix this issue. Referencing https://github.com/jekyll/jekyll-redirect-from#customizing-the-redirect-template ### Why are the changes needed? Fix doc links, such as https://spark.apache.org/docs/latest/sql-reference.html ### Does this PR introduce _any_ user-facing change? no ### How was this patch tested? Build doc and verify locally. ```html <!DOCTYPE html> <html lang="en-US"> <meta charset="utf-8"> <title>Redirecting…</title> <link rel="canonical" href="/building-spark.html"> <script>location="/building-spark.html"</script> <meta http-equiv="refresh" content="0; url=/building-spark.html"> <meta name="robots" content="noindex"> <h1>Redirecting…</h1> <a href="/building-spark.html">Click here if you are not redirected.</a> </html>% ``` ### Was this patch authored or co-authored using generative AI tooling? no Closes #42848 from yaooqinn/SPARK-45098. Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Dongjoon Hyun <dhyun@apple.com> (cherry picked from commit 81bc38e) Signed-off-by: Dongjoon Hyun <dhyun@apple.com>
|
Merged to master/3.5. |
|
thank you @srowen and @dongjoon-hyun |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes were proposed in this pull request?
In https://dist.apache.org/repos/dist/dev/spark/v3.5.0-rc4-docs/_site/, these links are supposed to redirect to the correct targets, but failed because there are no
.htmlextensions.This PR customs the redirect template to add extensions to fix this issue. Referencing https://github.com/jekyll/jekyll-redirect-from#customizing-the-redirect-template
Why are the changes needed?
Fix doc links, such as https://spark.apache.org/docs/latest/sql-reference.html
Does this PR introduce any user-facing change?
no
How was this patch tested?
Build doc and verify locally.
Was this patch authored or co-authored using generative AI tooling?
no