Documentation updates for RAPIDS for Apache Spark -> NVIDIA cuDF plugin for Apache Spark rename - #15114
Conversation
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
…-spark-rename-1
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
amahussein
left a comment
There was a problem hiding this comment.
Thanks @sameerz
The docs site chrome still advertises the old product/repo: docs/_config.yml (line 21) has aux-link labels for “RAPIDS Accelerator for Apache Spark” and links the plugin to github.com/nvidia/spark-rapids. For a rename PR, that visible navigation should probably become cuDF for Spark / cudf-spark.
A few polish issues: git diff --check reports trailing whitespace in README.md, docs/download.md, docs/dev/mem_debug.md, and docs/supported_ops.md.
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
|
Thanks for the review.
Updated docs/_config.yml
Removed extraneous spaces |
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
| - "//docs.nvidia.com/spark-rapids/user-guide/latest/index.html" | ||
| "RAPIDS Accelerator for Apache Spark Plugin on Github": | ||
| - "//github.com/nvidia/spark-rapids" | ||
| "cuDF for Apache Spark User Guide": |
There was a problem hiding this comment.
For the docs site chrome / User Guide route: I drafted the companion docs MR to move the published user guide route to the new product path in documentation repo: MR179
I also requested the docs owner to update the Docs Hub routing. Until that route is live, links under https://docs.nvidia.com/cudf-spark/user-guide/... may still 404
There was a problem hiding this comment.
MR179 is still also under review
There was a problem hiding this comment.
We can do a follow up PR once MR179 is merged. This change will roll out during the course of 26.08.
|
There are still a few visible naming inconsistencies between
|
Thanks for the feedback. The first instance of referring to the product requires us to use the Apache Spark full name per the guidelines. Following mentions can use Spark. That's the rationale for the naming. |
Greptile SummaryThis PR is a broad documentation rename rolling out the rebranding of "RAPIDS Accelerator for Apache Spark" to "NVIDIA cuDF plugin for Apache Spark" across 43 files, in parallel with the GitHub repository rename from
Confidence Score: 5/5Safe to merge — all changes are documentation text and Maven metadata with no impact on plugin runtime behavior. Every changed line is either a product name string, a GitHub URL swap (spark-rapids → cudf-spark), or Maven project metadata. No functional Scala code paths, no GPU operator logic, no configuration key names, and no artifact coordinates are altered. The docs.nvidia.com user-guide URLs are intentionally left unchanged pending a separate external-docs migration, which is consistent throughout the PR. Files Needing Attention: No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[PR 15114 - Rename Rollout] --> B[GitHub Repo References]
A --> C[Product Name Strings]
A --> D[Maven Metadata]
A --> E[External Docs URLs]
B --> B1[spark-rapids to cudf-spark]
B --> B2[spark-rapids-jni to cudf-spark-jni]
C --> C1[RAPIDS Accelerator to NVIDIA cuDF plugin]
C --> C2[RapidsConf.scala doc strings]
C --> C3[TypeChecks.scala tables]
D --> D1[pom.xml SCM URLs updated]
D --> D2[Artifact IDs unchanged]
E --> E1[docs.nvidia.com URLs intentionally unchanged]
Reviews (12): Last reviewed commit: "Merge branch 'release/26.08' into cudf-s..." | Re-trigger Greptile |
amahussein
left a comment
There was a problem hiding this comment.
Thanks @sameerz
LGTM
|
build |
|
build |
…-spark-rename-1
…-spark-rename-1
…st mention: NVIDIA cuDF plugin for Apache Spark, Short form for subsequent mentions: (the/this) cuDF plugin. 2. Added a number of files that were missed in the first iteration. 3. Used AI to review and find errors Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
…-spark-rename-1
|
build |
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
…k-rapids into cudf-spark-rename-1
…into cudf-spark-rename-1
…k-rapids into cudf-spark-rename-1
|
Want your agent to iterate on Greptile's feedback? Try greploops. |
|
build |
| To get started and try the plugin out use the [getting started guide](https://docs.nvidia.com/spark-rapids/user-guide/latest/getting-started/overview.html). | ||
|
|
||
| [](https://deepwiki.com/NVIDIA/spark-rapids) | ||
| [](https://deepwiki.com/NVIDIA/cudf-spark) |
There was a problem hiding this comment.
Nit: The deepwiki page still says RAPIDS Accelerator for Apache Spark. Are we able to update it accordingly?
There was a problem hiding this comment.
Once we rename the link it should trigger a rebuild of the deepwiki page. Let's see if it works.
|
build |
|
build |
1 similar comment
|
build |
Contributes to #15107
Description
The https://github.com/nvidia/spark-rapids repository has been renamed to https://github.com/nvidia/cudf-spark. This PR rolls out name changes for content and links referenced in the documentation.
Not changed here are documentation updates for configurations. Configurations will be added to support the new product name (removing rapids) with a deprecation period. Documentation for configurations can be updated when new configuration names are enabled.
Note that this PR modifies some generated documentation, so pre-merge CI should be enabled.
Checklists
Documentation
Testing
(Please provide the names of the existing tests in the PR description.)
Performance