Skip to content

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

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

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

Conversation

@bdice

@bdice bdice commented Aug 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

Move the RAPIDS documentation portal to https://docs.nvidia.com/datascience/ while keeping unmigrated API documentation available on docs.rapids.ai.

  • Publish the portal with rapidsai/shared-actions/publish-docs. Exclude deployment/* from uploads and deletions so rapidsai/deployment retains ownership of that subtree.
  • Keep a separate Netlify deployment for unmigrated libraries and releases. Generate permanent redirects for portal pages and migrated API versions, without a global catch-all that would intercept hosted API content or shared assets.
  • Update portal links, canonical URLs, and the notices RSS feed for the new location. Resolve API links using the existing library migration metadata.

Rollout checks

  • Confirm the NVIDIA publishing secrets and existing source-S3/Netlify configuration, including a populated Akamai notification email list.
  • Verify the first NVIDIA publish and Akamai cache refresh, then check redirects and remaining API content on docs.rapids.ai.

@netlify

netlify Bot commented Aug 20, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for docs-rapids-ai ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 32ca7e3
🔍 Latest deploy log https://app.netlify.com/projects/docs-rapids-ai/deploys/6aa591bdbc6cda000867777f
😎 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
bdice
bdice commented Aug 20, 2026
View reviewed changes
Comment thread .github/workflows/deploy-redirects.yaml Outdated
on:
workflow_dispatch:
inputs:
status:

@bdice bdice Aug 20, 2026

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

@bdice bdice Aug 20, 2026

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/")

@bdice bdice Aug 20, 2026

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/.

@ncclementi ncclementi mentioned this pull request Aug 24, 2026
Open
@bdice
bdice marked this pull request as ready for review September 9, 2026 21:10
@bdice
bdice requested a review from a team as a code owner September 9, 2026 21:10
@jayavenkatesh19

jayavenkatesh19 commented Sep 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

I just went through this PR, and I think we can make a small change in the publish-docs shared action to make the workflow better.

This workflow publishes at the /datascience root, so it has one requirement the current action does not support, which is to ensure that /datascience/deployment/* is excluded from both upload and delete, since that subtree is published by rapidsai/deployment

One idea to resolve this would be to add an optional target-s3-exclude input to publish-docs. This workflow would then look something like this:

uses: rapidsai/shared-actions/publish-docs@main
with:
  source-path: _site
  target-s3-key: datascience
  target-s3-exclude: deployment/*
  # existing NVIDIA AWS and Akamai inputs

That would eliminate the need for AWS setup, S3 sync, Akamai dependency installation, flush requests and cleanup which is all done in inline code in the workflow, in favour of using the shared-action, while maintaining independence of the deployment docs.

Happy to open a PR on shared-actions, if we decide to go with this.

@jayavenkatesh19 jayavenkatesh19 mentioned this pull request Sep 10, 2026
Merged
rapids-bot Bot pushed a commit to rapidsai/shared-actions that referenced this pull request Sep 11, 2026
@jayavenkatesh19
add a new flag to exclude subtrees in publish-docs (#145)
82e2c50 
Add an optional `target-s3-exclude` input to the `publish-docs` action

Newline separated glob patterns can be passed to the `aws s3 sync` as `--exclude` flags. These paths are neither uploaded or deleted as a result and a subtree published by another workflow can be independent under the same location. 

Towards [rapidsai/docs#827](rapidsai/docs#827 (comment)), with the aim of publishing the deployment docs separate from the main RAPIDS docs.

Authors:
  - Jaya Venkatesh (https://github.com/jayavenkatesh19)

Approvers:
  - Bradley Dice (https://github.com/bdice)

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

Reviewers

No reviews

Assignees

No one assigned

Labels

improvement non-breaking

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bdice @jayavenkatesh19