Skip to content

Documentation updates for RAPIDS for Apache Spark -> NVIDIA cuDF plugin for Apache Spark rename - #15114

Merged
sameerz merged 23 commits into
NVIDIA:release/26.08from
sameerz:cudf-spark-rename-1
Jul 29, 2026
Merged

Documentation updates for RAPIDS for Apache Spark -> NVIDIA cuDF plugin for Apache Spark rename#15114
sameerz merged 23 commits into
NVIDIA:release/26.08from
sameerz:cudf-spark-rename-1

Conversation

@sameerz

@sameerz sameerz commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

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

  • Updated for new or modified user-facing features or behaviors
  • No user-facing change

Testing

  • Added or modified tests to cover new code paths
  • Covered by existing tests
    (Please provide the names of the existing tests in the PR description.)
  • Not required

Performance

  • Tests ran and results are added in the PR description
  • Issue filed with a link in the PR description
  • Not required

Sameer Raheja added 3 commits June 17, 2026 12:30
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
@sameerz
sameerz requested a review from a team as a code owner June 22, 2026 21:47
@sameerz sameerz added the documentation Improvements or additions to documentation label Jun 22, 2026
@sameerz
sameerz requested a review from nvliyuan June 22, 2026 21:48

@amahussein amahussein left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread pom.xml Outdated
Comment thread docs/dev/microk8s.md Outdated
Comment thread docs/download.md Outdated
Comment thread docs/dev/shims.md Outdated
Comment thread docs/dev/microk8s.md Outdated
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
@sameerz

sameerz commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator Author

Thanks for the review.

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.

Updated docs/_config.yml

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.

Removed extraneous spaces

Sameer Raheja added 2 commits June 22, 2026 22:23
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
Signed-off-by: Sameer Raheja <sraheja@.nvidia.com>
Comment thread docs/_config.yml Outdated
- "//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":

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MR179 is still also under review

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can do a follow up PR once MR179 is merged. This change will roll out during the course of 26.08.

@nvliyuan

Copy link
Copy Markdown
Collaborator

There are still a few visible naming inconsistencies between cuDF for Apache Spark and cuDF for Spark in the updated docs. If the official product name for this PR is cuDF for Apache Spark, these should be aligned:

  • README.md: the title says cuDF for Apache Spark, but the note says cuDF for Spark was formerly known... and the project name is cuDF for Spark.
  • docs/download.md: the intro link text says cuDF for Apache Spark, but later says cuDF for Spark requires..., classpath ... uses cuDF for Spark, and cuDF Spark consists....
  • docs/_config.yml: both aux link labels say cuDF for Apache Spark, which is different from the shorter cuDF for Spark wording used elsewhere.
  • Generated docs/config text also mixes both forms, e.g. docs/configs.md, docs/additional-functionality/advanced_configs.md, docs/supported_ops.md, and their source strings in RapidsConf.scala / TypeChecks.scala.

@sameerz

sameerz commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator Author

There are still a few visible naming inconsistencies between cuDF for Apache Spark and cuDF for Spark in the updated docs. If the official product name for this PR is cuDF for Apache Spark, these should be aligned:

* `README.md`: the title says `cuDF for Apache Spark`, but the note says `cuDF for Spark was formerly known...` and `the project name is cuDF for Spark`.

* `docs/download.md`: the intro link text says `cuDF for Apache Spark`, but later says `cuDF for Spark requires...`, `classpath ... uses cuDF for Spark`, and `cuDF Spark consists...`.

* `docs/_config.yml`: both aux link labels say `cuDF for Apache Spark`, which is different from the shorter `cuDF for Spark` wording used elsewhere.

* Generated docs/config text also mixes both forms, e.g. `docs/configs.md`, `docs/additional-functionality/advanced_configs.md`, `docs/supported_ops.md`, and their source strings in `RapidsConf.scala` / `TypeChecks.scala`.

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-apps

greptile-apps Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This 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 NVIDIA/spark-rapids to NVIDIA/cudf-spark.

  • All GitHub issue/PR/discussion links and repository SCM metadata in pom.xml are updated to point at NVIDIA/cudf-spark; artifact IDs and Maven coordinates are intentionally left unchanged per the PR description.
  • Configuration documentation strings in RapidsConf.scala and operator-support tables in TypeChecks.scala are updated to use the new product name; all docs.nvidia.com/spark-rapids/... user-guide URLs are intentionally left unchanged, as those are managed by NVIDIA's external docs team and require a separate migration.

Confidence Score: 5/5

Safe 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

Filename Overview
pom.xml SCM metadata and project name updated to cudf-spark; artifact IDs and Maven coordinates correctly left unchanged
scala2.13/pom.xml Mirrors pom.xml rename; SCM URLs and project name updated consistently
sql-plugin/src/main/scala/com/nvidia/spark/rapids/RapidsConf.scala Config doc strings updated from 'RAPIDS Accelerator' to 'cuDF plugin'; GitHub issue URLs updated; functional code untouched
sql-plugin/src/main/scala/com/nvidia/spark/rapids/TypeChecks.scala Supported-ops help text updated; also fixes a typo 'Neither Spark not' to 'Neither Spark nor'; no functional changes
docs/compatibility.md Product name and GitHub issue links updated throughout; docs.nvidia.com links left unchanged intentionally
docs/_config.yml Aux-link labels updated to new name; docs.nvidia.com URL intentionally unchanged pending external docs migration
docs/download.md Product name updated throughout download page; Maven artifact names and JAR download URLs correctly unchanged
CONTRIBUTING.md GitHub links and product name updated; cudf-spark-jni link updated; build example path updated to reflect cudf-spark

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]
Loading

Reviews (12): Last reviewed commit: "Merge branch 'release/26.08' into cudf-s..." | Re-trigger Greptile

Comment thread docs/compatibility.md
amahussein
amahussein previously approved these changes Jun 24, 2026

@amahussein amahussein left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sameerz
LGTM

@amahussein

Copy link
Copy Markdown
Collaborator

build

@amahussein

Copy link
Copy Markdown
Collaborator

build

amahussein
amahussein previously approved these changes Jun 25, 2026
Sameer Raheja added 2 commits July 26, 2026 21:37
…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>
@sameerz sameerz changed the title Documentation updates for RAPIDS for Apache Spark -> cuDF for Spark rename Documentation updates for RAPIDS for Apache Spark -> NVIDIA cuDF plugin for Apache Spark rename Jul 27, 2026
@sameerz
sameerz requested review from a team and nvliyuan July 27, 2026 05:43
nvliyuan
nvliyuan previously approved these changes Jul 27, 2026

@nvliyuan nvliyuan left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LTGM

@sameerz

sameerz commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator Author

build

Comment thread docs/dev/get-json-object-dump-tool.md Outdated
Comment thread docs/download.md Outdated
Sameer Raheja added 2 commits July 27, 2026 21:43
@greptile-apps

greptile-apps Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Want your agent to iterate on Greptile's feedback? Try greploops.

@sameerz
sameerz requested review from GaryShen2008 and nvliyuan July 28, 2026 04:57
@sameerz

sameerz commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator Author

build

Comment thread docs/dev/get-json-object-dump-tool.md Outdated
Comment thread docs/dev/get-json-object-dump-tool.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread README.md
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).

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/NVIDIA/spark-rapids)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/NVIDIA/cudf-spark)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: The deepwiki page still says RAPIDS Accelerator for Apache Spark. Are we able to update it accordingly?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once we rename the link it should trigger a rebuild of the deepwiki page. Let's see if it works.

nvliyuan
nvliyuan previously approved these changes Jul 28, 2026
@GaryShen2008

Copy link
Copy Markdown
Collaborator

build

@GaryShen2008

Copy link
Copy Markdown
Collaborator

build

1 similar comment
@sameerz

sameerz commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator Author

build

@sameerz
sameerz merged commit 72903fe into NVIDIA:release/26.08 Jul 29, 2026
55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants