Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// For format details, see https://aka.ms/devcontainer.json.
{
"name": "RAPIDS Docs",
"image": "mcr.microsoft.com/devcontainers/python:3.14-bookworm",
"forwardPorts": [8000],
"portsAttributes": {
"8000": {
"label": "RAPIDS Docs",
"onAutoForward": "openPreview"
}
},
"postCreateCommand": "pipx install uv && uv sync --locked"
}
14 changes: 4 additions & 10 deletions .github/workflows/deploy-cudf-java-docs.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
name: Deploy cudf-java docs

on:
workflow_dispatch:
inputs:
Expand All @@ -10,20 +9,16 @@ on:
version:
description: "Version being released. Format: YY.MM or YY.MM.P e.g 24.08 or 24.08.1"
required: true

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

defaults:
run:
shell: bash

permissions:
id-token: write
contents: write
pull-requests: write

jobs:
deploy-cudf-java-docs:
runs-on: ubuntu-latest
Expand All @@ -32,17 +27,16 @@ jobs:
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@61815dcd50bd041e203e49132bacad1fd04d2708 # v5.1.1
- uses: aws-actions/configure-aws-credentials@61815dcd50bd041e203e49132bacad1fd04d2708 #v5.1.1
with:
role-to-assume: ${{ vars.AWS_ROLE_ARN }}
aws-region: ${{ vars.AWS_REGION }}
role-duration-seconds: 7200
role-duration-seconds: 7200 # 2h
- name: Upload cudf-java docs to S3
env:
VERSION: ${{ inputs.version }}
run: ci/upload_cudf_java_docs.sh "${VERSION}"
- name: Update stable value for cudf-java
- name: Update stable value for cudf-java in docs.yml and projects-to-versions.json
env:
NEW_STABLE_VALUE: ${{ inputs.new_stable_value }}
VERSION: ${{ inputs.version }}
Expand All @@ -57,7 +51,7 @@ jobs:

jq --arg version "$VERSION" '."cudf-java".stable = $version' ci/customization/projects-to-versions.json > tmp.json \
&& mv tmp.json ci/customization/projects-to-versions.json
echo "Updated stable version for cudf-java to $VERSION"
echo "Updated cudf-java stable version to $VERSION in projects-to-versions.json"
- name: Create Pull Request
uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
with:
Expand Down
17 changes: 5 additions & 12 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
name: Deploy site

on:
schedule:
- cron: "0 9 * * *"
Expand All @@ -8,26 +7,21 @@ on:
branches:
- main
- "pull-request/[0-9]+"

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

defaults:
run:
shell: bash

permissions:
id-token: write
contents: read

jobs:
build:
name: Build (and deploy)
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0
persist-credentials: false
Expand All @@ -39,21 +33,20 @@ jobs:
run: uv sync --locked
- name: Build and validate portal
run: make check
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@61815dcd50bd041e203e49132bacad1fd04d2708 # v5.1.1
- uses: aws-actions/configure-aws-credentials@61815dcd50bd041e203e49132bacad1fd04d2708 #v5.1.1
with:
role-to-assume: ${{ vars.AWS_ROLE_ARN }}
aws-region: ${{ vars.AWS_REGION }}
role-duration-seconds: 7200
role-duration-seconds: 7200 # 2h
- name: Assemble complete documentation site
run: make assemble
- name: Deploy site
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_API_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_DOCS_SITE_ID }}
# TODO: use official netlify-cli pkg after https://github.com/netlify/cli/issues/1809
# is resolved and deployed.
run: |
# TODO: use the official netlify-cli package after
# https://github.com/netlify/cli/issues/1809 is resolved and deployed.
npm install --global --force @aschmidt8/netlify-cli

ARGS=""
Expand Down
3 changes: 2 additions & 1 deletion .github/zizmor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ rules:
unpinned-uses:
config:
policies:
# Require SHA-pinning except for RAPIDS-managed reusable actions and workflows.
# We require SHA-pinning for all workflows and actions _except_ for those from
# rapidsai/shared-workflows and rapidsai/shared-actions
"rapidsai/shared-workflows/*": any
"rapidsai/shared-actions/*": any
"*": hash-pin
2 changes: 1 addition & 1 deletion .python-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.12
3.14
7 changes: 5 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,19 @@ the locked development environment:
uv sync --locked
```

Alternatively, open the repository in its development container. The container
installs uv and the locked environment automatically.

## Development

Build the portal and serve the rendered site at <http://localhost:8004/>:
Build the portal and serve the rendered site:

```shell
make html
make serve
```

Pass a different port when needed:
The server uses port 8000 by default. Pass a different port when needed:

```shell
make serve PORT=8080
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
UV ?= uv
PORT ?= 8004
PORT ?= 8000
AWS_PROFILE ?=

.PHONY: assemble check clean full html lint serve test validate
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ make html
make serve
```

The rendered portal is written to `_site` and served at
<http://localhost:8004/> by default.
The rendered portal is written to `_site`. The server uses port 8000 by default;
override it with `PORT` (for example, `make serve PORT=8080`).

## Build the complete site

Expand Down
2 changes: 1 addition & 1 deletion ci/check_style.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# SPDX-FileCopyrightText: Copyright (c) 2024-2026, NVIDIA CORPORATION & AFFILIATES.
# SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES.
# All rights reserved.
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion ci/customization/customize_docs_in_folder.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES.
# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES.
# All rights reserved.
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion ci/customization/lib_map.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# SPDX-FileCopyrightText: Copyright (c) 2024-2026, NVIDIA CORPORATION & AFFILIATES.
# SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES.
# All rights reserved.
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion ci/update_symlinks.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# SPDX-FileCopyrightText: Copyright (c) 2025-2026, NVIDIA CORPORATION & AFFILIATES.
# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES.
# All rights reserved.
# SPDX-License-Identifier: Apache-2.0

Expand Down
2 changes: 1 addition & 1 deletion ci/upload_cudf_java_docs.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# SPDX-FileCopyrightText: Copyright (c) 2024-2026, NVIDIA CORPORATION & AFFILIATES.
# SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES.
# All rights reserved.
# SPDX-License-Identifier: Apache-2.0

Expand Down