[SPARK-35909][DOCS] Fix broken Python Links in docs/sql-getting-started.md #33107
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
dhruvildave
changed the title
|
Can one of the admins verify this patch? |
| @@ -41,7 +41,7 @@ The entry point into all functionality in Spark is the [`SparkSession`](api/java | |||
|
|
|||
| <div data-lang="python" markdown="1"> | |||
|
|
|||
| The entry point into all functionality in Spark is the [`SparkSession`](api/python/pyspark.sql.html#pyspark.sql.SparkSession) class. To create a basic `SparkSession`, just use `SparkSession.builder`: | |||
| The entry point into all functionality in Spark is the [`SparkSession`](api/python/reference/api/pyspark.sql.SparkSession.html) class. To create a basic `SparkSession`, just use `SparkSession.builder`: | |||
There was a problem hiding this comment.
Hi, @dhruvildave . Just a question, in Apache Spark website, the original one seems to work correctly. Do we need this?
There was a problem hiding this comment.
Hello! Thanks for the review. I have created a small video showing exactly where the errors are encountered.
There was a problem hiding this comment.
Ah, got it. It's inside Python tab. I missed the point.
dongjoon-hyun
approved these changes
Jun 27, 2021
There was a problem hiding this comment.
+1, LGTM. Thank you, @dhruvildave .
Merged to master/3.1/3.0.
dongjoon-hyun
pushed a commit
that referenced
this pull request
Jun 27, 2021
…ed.md ### What changes were proposed in this pull request? The hyperlinks in Python code blocks in [Spark SQL Guide - Getting Started](https://spark.apache.org/docs/latest/sql-getting-started.html) currently point to invalid addresses and return 404. This pull request fixes that issue by pointing them to correct links in Python API docs. ### Why are the changes needed? Error in documentation classifies as a bug and hence needs to be fixed. ### Does this PR introduce _any_ user-facing change? Yes. This PR fixes documentation error in https://spark.apache.org/docs/latest/sql-getting-started.html ### How was this patch tested? This patch was locally built after cloning the repo from scratch and then doing a clean build after fixing the required problems. Closes #33107 from dhruvildave/sql-doc. Authored-by: Dhruvil Dave <dhruvil.dave@outlook.com> Signed-off-by: Dongjoon Hyun <dongjoon@apache.org> (cherry picked from commit a7369b3) Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
dongjoon-hyun
pushed a commit
that referenced
this pull request
Jun 27, 2021
…ed.md ### What changes were proposed in this pull request? The hyperlinks in Python code blocks in [Spark SQL Guide - Getting Started](https://spark.apache.org/docs/latest/sql-getting-started.html) currently point to invalid addresses and return 404. This pull request fixes that issue by pointing them to correct links in Python API docs. ### Why are the changes needed? Error in documentation classifies as a bug and hence needs to be fixed. ### Does this PR introduce _any_ user-facing change? Yes. This PR fixes documentation error in https://spark.apache.org/docs/latest/sql-getting-started.html ### How was this patch tested? This patch was locally built after cloning the repo from scratch and then doing a clean build after fixing the required problems. Closes #33107 from dhruvildave/sql-doc. Authored-by: Dhruvil Dave <dhruvil.dave@outlook.com> Signed-off-by: Dongjoon Hyun <dongjoon@apache.org> (cherry picked from commit a7369b3) Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
|
I added you to the Apache Spark contributor group and assigned SPARK-35909 to you. Welcome! :) |
|
Thanks @dhruvildave! |
flyrain
pushed a commit
to flyrain/spark
that referenced
this pull request
Sep 21, 2021
…ed.md ### What changes were proposed in this pull request? The hyperlinks in Python code blocks in [Spark SQL Guide - Getting Started](https://spark.apache.org/docs/latest/sql-getting-started.html) currently point to invalid addresses and return 404. This pull request fixes that issue by pointing them to correct links in Python API docs. ### Why are the changes needed? Error in documentation classifies as a bug and hence needs to be fixed. ### Does this PR introduce _any_ user-facing change? Yes. This PR fixes documentation error in https://spark.apache.org/docs/latest/sql-getting-started.html ### How was this patch tested? This patch was locally built after cloning the repo from scratch and then doing a clean build after fixing the required problems. Closes apache#33107 from dhruvildave/sql-doc. Authored-by: Dhruvil Dave <dhruvil.dave@outlook.com> Signed-off-by: Dongjoon Hyun <dongjoon@apache.org> (cherry picked from commit a7369b3) Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
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?
The hyperlinks in Python code blocks in Spark SQL Guide - Getting Started currently point to invalid addresses and return 404. This pull request fixes that issue by pointing them to correct links in Python API docs.
Why are the changes needed?
Error in documentation classifies as a bug and hence needs to be fixed.
Does this PR introduce any user-facing change?
Yes. This PR fixes documentation error in https://spark.apache.org/docs/latest/sql-getting-started.html
How was this patch tested?
This patch was locally built after cloning the repo from scratch and then doing a clean build after fixing the required problems.