Skip to content

X-ORG-722: Publish API docs to docs.nvidia.com - #724

Merged
ncclementi merged 3 commits into
rapidsai:mainfrom
josephine-wolf-oberholtzer:josephine/x-org-722-publish-docs
Jul 30, 2026
Merged

X-ORG-722: Publish API docs to docs.nvidia.com#724
ncclementi merged 3 commits into
rapidsai:mainfrom
josephine-wolf-oberholtzer:josephine/x-org-722-publish-docs

Conversation

@josephine-wolf-oberholtzer

@josephine-wolf-oberholtzer josephine-wolf-oberholtzer commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Closes #722

Let's publish these docs to https://docs.nvidia.com/datascience/deployment.

@josephine-wolf-oberholtzer
josephine-wolf-oberholtzer requested a review from a team as a code owner July 29, 2026 19:58

@ncclementi ncclementi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks pretty good, before merging, We have a question regarding the where the final url would land.

The deployment docs, go beyond the scope of datascience, it would be great to know if this is modifiable or not. See comment in line

target-aws-secret-access-key: ${{ secrets.NVIDIA_DOCS_AWS_SECRET_ACCESS_KEY }}
target-s3-bucket: ${{ secrets.NVIDIA_DOCS_S3_BUCKET }}
target-s3-key-suffix: ${{ steps.set-version.outputs.VERSION }} # stable or nightly
target-s3-key: datascience/deployment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm not sure we necessarily fall under datascience. Does this target s3 key, maps to what the final url would be?
If yes, @josephine-wolf-oberholtzer do we get to choose this, or not at all?

@mmccarty Do you have any input here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We did discuss that the deployment docs should go under /datascience/deploy. While it is modifiable, where do you propose it should be?

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.

  1. Yes, the S3 key maps to the final URL AFAIUI.
  2. datascience was the suggested naming convention from Alex. Let's take this to the migration project channel for hashing out? #swrapids-nvidia-migration.

@ncclementi

Copy link
Copy Markdown
Contributor

After discussion, it seem like /datascience is the placement for now. I'll approve this and we will revisit in the future if needed.

@ncclementi
ncclementi merged commit 61095b2 into rapidsai:main Jul 30, 2026
4 checks passed
@josephine-wolf-oberholtzer
josephine-wolf-oberholtzer deleted the josephine/x-org-722-publish-docs branch July 31, 2026 13:22
@josephine-wolf-oberholtzer

Copy link
Copy Markdown
Contributor Author

I'll have to come back to this - need to be able to run it in a CI container for the action to work.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[X-ORG] Publish docs to docs.nvidia.com via new shared workflow

3 participants