Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ncclementi merged 3 commits into from
Jul 30, 2026
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5f6ba5
X-ORG-722: Publish API docs to docs.nvidia.com
josephine-wolf-oberholtzer Jul 29, 2026
b228075
Lint
josephine-wolf-oberholtzer Jul 29, 2026
cc1ac08
Merge branch 'main' into josephine/x-org-722-publish-docs
josephine-wolf-oberholtzer Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 27 additions & 4 deletions .github/workflows/build-and-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ permissions:
contents: read

jobs:
conda:
build:
name: Build (and deploy)
runs-on: ubuntu-latest
steps:
Expand All @@ -44,8 +44,31 @@ jobs:
aws-region: ${{ vars.AWS_REGION }}
role-duration-seconds: 3600 # 1h

- name: Set version
id: set-version
run: echo "VERSION=${{ startsWith(github.event.ref, 'refs/tags/') && 'stable' || 'nightly' }}" >> "$GITHUB_OUTPUT"

- name: Sync HTML files to S3
if: ${{ github.repository == 'rapidsai/deployment' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch') }}
env:
DESTINATION_DIR: ${{ startsWith(github.event.ref, 'refs/tags/') && 'stable' || 'nightly' }}
run: aws s3 sync --no-progress --delete build/dirhtml "s3://rapidsai-docs/deployment/html/${DESTINATION_DIR}"
VERSION: ${{ steps.set-version.outputs.VERSION }}
if: ${{ github.repository == 'rapidsai/deployment' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch') }}
run: aws s3 sync --no-progress --delete build/dirhtml "s3://rapidsai-docs/deployment/html/${VERSION}"

- name: Publish to docs.nvidia.com
if: ${{ github.repository == 'rapidsai/deployment' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch') }}
uses: rapidsai/shared-actions/publish-docs@main
with:
akamai-access-token: ${{ secrets.NVIDIA_DOCS_AKAMAI_ACCESS_TOKEN }}
akamai-client-secret: ${{ secrets.NVIDIA_DOCS_AKAMAI_CLIENT_SECRET }}
akamai-client-token: ${{ secrets.NVIDIA_DOCS_AKAMAI_CLIENT_TOKEN }}
akamai-emails-to-notify: ${{ secrets.NVIDIA_DOCS_AKAMAI_EMAILS_TO_NOTIFY }}
akamai-host: ${{ secrets.NVIDIA_DOCS_AKAMAI_HOST }}
akamai-request-name: rapidsai-deployment-${{ steps.set-version.outputs.VERSION }}
dry-run: false
source-path: build/dirhtml
target-aws-access-key-id: ${{ secrets.NVIDIA_DOCS_AWS_ACCESS_KEY_ID }}
target-aws-region: ${{ secrets.NVIDIA_DOCS_AWS_REGION }}
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

@ncclementi ncclementi Jul 29, 2026

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?

@taureandyernv taureandyernv Jul 30, 2026

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?

@josephine-wolf-oberholtzer josephine-wolf-oberholtzer Jul 30, 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.

  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.

Loading