Skip to content

Migrate the RAPIDS docs portal while preserving API hosting - #827

Draft
bdice wants to merge 3 commits into
rapidsai:mainfrom
bdice:agent/migrate-portal-to-docs-nvidia
Draft

Migrate the RAPIDS docs portal while preserving API hosting#827
bdice wants to merge 3 commits into
rapidsai:mainfrom
bdice:agent/migrate-portal-to-docs-nvidia

Conversation

@bdice

@bdice bdice commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • build the RAPIDS portal with https://docs.nvidia.com/datascience/ as its canonical base and route migrated API deep links to numeric NVIDIA documentation paths
  • publish portal-owned files to the NVIDIA docs S3 bucket and flush Akamai while preserving the independently published datascience/deployment/ subtree
  • continue assembling and publishing the docs.rapids.ai compatibility site with real API documentation for libraries and releases that have not migrated
  • generate forced redirects for migrated API aliases and numeric versions plus explicit portal and deployment routes, without a global catch-all that would intercept hosted API content or shared assets

Rollout safety

  • this PR is intentionally a draft
  • first_docs_nvidia_com_release controls the cutover per library and release: earlier releases and libraries without a migration version remain on docs.rapids.ai
  • compatibility-site redirects are always forced HTTP 301 rules
  • the compatibility workflow validates that an unmigrated library's legacy, stable, and nightly documentation is present before deployment
  • the NVIDIA S3 sync excludes deployment/* from both upload and deletion

Validation

  • all pre-commit hooks, including YAML, Ruff, copyright, and zizmor
  • 18 passing pytest tests, including migrated, unmigrated, and pre-migration redirect boundaries
  • strict Sphinx dirhtml builds with warnings treated as errors for both production base URLs
  • rendered-site validation of required pages, canonical URLs, RSS URLs, API routing, and remaining legacy-domain links
  • generated hybrid redirect preview and git diff --check

Follow-ups before marking ready

  • confirm the NVIDIA publication secrets and existing source-S3/Netlify configuration
  • manually validate the first NVIDIA portal publish and Akamai propagation
  • validate both permanent redirects and hosted API content on the compatibility site

@netlify

netlify Bot commented Aug 20, 2026

Copy link
Copy Markdown

Deploy Preview for docs-rapids-ai ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 044be0b
🔍 Latest deploy log https://app.netlify.com/projects/docs-rapids-ai/deploys/6a87580a5755e00008ed4389
😎 Deploy Preview https://deploy-preview-827--docs-rapids-ai.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@bdice bdice changed the title Migrate RAPIDS docs portal to docs.nvidia.com Migrate the RAPIDS docs portal while preserving API hosting Aug 20, 2026
Comment thread .github/workflows/deploy-redirects.yaml Outdated
on:
workflow_dispatch:
inputs:
status:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Remove this option, make it always 301.

Comment thread .github/workflows/pr.yaml Outdated
run: |
uv run python scripts/generate_redirect_site.py \
--output _redirect_site/_redirects \
--status 302

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Remove this option, always use status 301.

Comment thread extensions/rapids_docs/lifecycle.py Outdated
def _context(app, docname: str = "index") -> dict:
data = app.rapids_portal_data
config = getattr(app, "config", None)
site_baseurl = getattr(config, "html_baseurl", "https://docs.rapids.ai/")

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The default should be https://docs.nvidia.com/datascience/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant