Skip to content

gpu: redirect to official setup instructions#23924

Open
gjulianm wants to merge 3 commits into
masterfrom
guillermo.julian/redirect-gpu-docs
Open

gpu: redirect to official setup instructions#23924
gjulianm wants to merge 3 commits into
masterfrom
guillermo.julian/redirect-gpu-docs

Conversation

@gjulianm
Copy link
Copy Markdown
Contributor

@gjulianm gjulianm commented Jun 3, 2026

What does this PR do?

Removes the setup instructions from the check README, redirecting instead to the setup page.

Motivation

Avoid duplicate instructions that get out of sync.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Add qa/required if this PR needs QA validation, or qa/skip-qa if it does not. Exactly one of the two is required.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

Copy link
Copy Markdown
Contributor

@mbertrone mbertrone left a comment

Choose a reason for hiding this comment

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

Review

Two gate-level things to confirm before merge:

Rebase risk: This PR branches from an older master (gpu/README.md at ~166 lines). Current master has a 336-line README with a full docker run block, mixed-environment Helm two-chart instructions, and expanded Operator/DAP guidance that landed in separate subsequent PRs. When this rebases, the deletion needs to cleanly remove the current expanded setup section, not the older shorter one. Please rebase onto latest master and re-verify the diff before merging.

Unverified redirect target: The entire PR depends on https://docs.datadoghq.com/gpu_monitoring/setup/ being live and covering at minimum the Host, Docker, Helm, and Operator/mixed-environment setup paths removed here. If that page is incomplete or not yet published, users are left with no setup guidance. Please confirm it's live and comprehensive before merging.

Comment thread gpu/README.md Outdated
Comment thread gpu/README.md Outdated
Comment thread gpu/README.md Outdated
Comment thread gpu/README.md Outdated
OliviaShoup
OliviaShoup previously approved these changes Jun 4, 2026
Copy link
Copy Markdown
Contributor

@OliviaShoup OliviaShoup left a comment

Choose a reason for hiding this comment

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

Nice de-duplication — replacing the long, drift-prone setup block with a redirect to the canonical setup docs is a good call, and the target page resolves. README structure stays valid and there are no orphaned link references after the deletion. Approving.

One quick must-fix (a missing period) and a couple of small suggestions inline — none blocking.

One thing worth confirming: the removed content included the requirements (NVIDIA driver ≥ 450.51, kernel ≥ 5.8, Linux-only). Those should now live on the setup docs page you're redirecting to — just worth a sanity-check that they're covered there so that info isn't lost.

Comment thread gpu/README.md Outdated
Comment thread gpu/README.md Outdated
Comment thread gpu/README.md Outdated
@temporal-github-worker-1 temporal-github-worker-1 Bot dismissed OliviaShoup’s stale review June 4, 2026 15:57

Review from OliviaShoup is dismissed. Related teams and files:

  • documentation
    • gpu/README.md
@gjulianm
Copy link
Copy Markdown
Contributor Author

gjulianm commented Jun 4, 2026

Review

Two gate-level things to confirm before merge:

Rebase risk: This PR branches from an older master (gpu/README.md at ~166 lines). Current master has a 336-line README with a full docker run block, mixed-environment Helm two-chart instructions, and expanded Operator/DAP guidance that landed in separate subsequent PRs. When this rebases, the deletion needs to cleanly remove the current expanded setup section, not the older shorter one. Please rebase onto latest master and re-verify the diff before merging.

Fixed, rebased on latest

Unverified redirect target: The entire PR depends on https://docs.datadoghq.com/gpu_monitoring/setup/ being live and covering at minimum the Host, Docker, Helm, and Operator/mixed-environment setup paths removed here. If that page is incomplete or not yet published, users are left with no setup guidance. Please confirm it's live and comprehensive before merging.

All docs are completed in that live page.

@dd-octo-sts
Copy link
Copy Markdown
Contributor

dd-octo-sts Bot commented Jun 4, 2026

Validation Report

All 21 validations passed.

Show details
Validation Description Status
agent-reqs Verify check versions match the Agent requirements file
ci Validate CI configuration and code coverage settings
codeowners Validate every integration has a CODEOWNERS entry
config Validate default configuration files against spec.yaml
dep Verify dependency pins are consistent and Agent-compatible
http Validate integrations use the HTTP wrapper correctly
imports Validate check imports do not use deprecated modules
integration-style Validate check code style conventions
jmx-metrics Validate JMX metrics definition files and config
labeler Validate PR labeler config matches integration directories
legacy-signature Validate no integration uses the legacy Agent check signature
license-headers Validate Python files have proper license headers
licenses Validate third-party license attribution list
metadata Validate metadata.csv metric definitions
models Validate configuration data models match spec.yaml
openmetrics Validate OpenMetrics integrations disable the metric limit
package Validate Python package metadata and naming
qa-label Validate the pull request declares whether it needs QA for the next Agent release
readmes Validate README files have required sections
saved-views Validate saved view JSON file structure and fields
version Validate version consistency between package and changelog

View full run

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.

4 participants