-
Notifications
You must be signed in to change notification settings - Fork 28.3k
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
[SPARK-44997][DOCS] Align example order (Python -> Scala/Java -> R) in all Spark Doc Content #42712
Conversation
…n all Spark Doc Content
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.
I am fine with this.
docs/index.md
Outdated
@@ -34,7 +34,7 @@ source, visit [Building Spark](building-spark.html). | |||
|
|||
Spark runs on both Windows and UNIX-like systems (e.g. Linux, Mac OS), and it should run on any platform that runs a supported version of Java. This should include JVMs on x86_64 and ARM64. It's easy to run locally on one machine --- all you need is to have `java` installed on your system `PATH`, or the `JAVA_HOME` environment variable pointing to a Java installation. | |||
|
|||
Spark runs on Java 8/11/17, Scala 2.12/2.13, Python 3.8+, and R 3.5+. | |||
Spark runs on Python 3.8+, Scala 2.12/2.13, Java 8/11/17 and R 3.5+. |
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.
-1 for this change.
docs/_layouts/global.html
Outdated
@@ -128,7 +128,7 @@ <h1 style="max-width: 680px;">Apache Spark - A Unified engine for large-scale da | |||
<div class="row mt-5"> | |||
<div class="col-12 col-lg-6 no-gutters"> | |||
Apache Spark is a unified analytics engine for large-scale data processing. | |||
It provides high-level APIs in Java, Scala, Python and R, | |||
It provides high-level APIs in Python, Scala, Java and R, |
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.
Also, I'm -1 with this.
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.
This cannot be a follow-up of Make Python the first code example tab in the Spark documentation
because the original one is about example tab
.
In addition, I believe we should preserve the original statement like the following as the key message.
Spark runs on Java 8/11/17, Scala 2.12/2.13, Python 3.8+, and R 3.5+.
Should probably send an email to the dev mailing list, and see how it goes. |
Yep, I believe so because it's out of scope of |
Okay, let me first revert the changes outside of |
Thank you, @panbingkun . For the others, it looks good to me and consistent with the AS-IS consensus, too. |
…n all Spark Doc Content
@@ -71,9 +71,9 @@ | |||
<li class="nav-item dropdown"> | |||
<a href="#" class="nav-link dropdown-toggle" id="navbarAPIDocs" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">API Docs</a> | |||
<div class="dropdown-menu" aria-labelledby="navbarAPIDocs"> | |||
<a class="dropdown-item" href="api/python/index.html">Python</a> |
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.
…n all Spark Doc Content
…n all Spark Doc Content
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.
+1, LGTM. Thank you, @panbingkun and all.
Merged to master for Apache Spark 4. |
What changes were proposed in this pull request?
The pr is following up pr https://issues.apache.org/jira/browse/SPARK-42642 and https://issues.apache.org/jira/browse/SPARK-44819.
The pr aims to align example order (Python -> Scala/Java -> R) in all Spark Doc Content and fix some parts bugs of the
structured-streaming-programming-guide.html
page where Python is not the first language, include:1.quick-start.md
2.structured-streaming-programming-guide.md (Python is not the first language in some code snippets on this page)
3.rdd-programming-guide.md
4.streaming-programming-guide.md
5.sql-getting-started.md
6.README.md
7.index.md
8.ml-pipeline.md
9.sql-programming-guide.md
10._layouts/global.html
Why are the changes needed?
The order of examples should be consistent (Python -> Scala/Java -> R)
Does this PR introduce any user-facing change?
No.
How was this patch tested?
Manual testing.
Was this patch authored or co-authored using generative AI tooling?
No.