Skip to content

Add deprecated warning banner to ddsql_schema dataset pages - #38514

Open
irenegaunab wants to merge 5 commits into
masterfrom
irene.gauna/add-deprecation-status
Open

Add deprecated warning banner to ddsql_schema dataset pages#38514
irenegaunab wants to merge 5 commits into
masterfrom
irene.gauna/add-deprecation-status

Conversation

@irenegaunab

@irenegaunab irenegaunab commented Jul 28, 2026

Copy link
Copy Markdown

Summary

Dataset pages with status: deprecated now show an alert warning banner explaining the table no longer returns data.

This supports the REDAPL→UDM migration where ~30 retired cloud resource tables were deprecated (DSEM-999). Here you can see a list of deprecated tables. Without this change, the public docs such as this one would show no indication that a table is deprecated.

What does this PR do? What is the motivation?

Adds a conditional block to layouts/ddsql_schema/single.html that renders an alert-warning banner when .Params.status == "deprecated":

Deprecated: This table is deprecated and no longer returns data. Querying it returns empty results.

Testing

Verified the deprecated warning banner renders correctly on the branch preview:
https://docs-staging.datadoghq.com/irene.gauna/add-deprecation-status/ddsql_reference/data_directory/aws/aws.resource_tags/
Screenshot 2026-07-28 at 17 44 58

🤖 Generated with Claude Code

Dataset pages with status: deprecated now show an alert-warning banner
explaining the table no longer returns data.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@irenegaunab
irenegaunab requested a review from a team as a code owner July 28, 2026 10:47
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Jul 28, 2026
@irenegaunab
irenegaunab requested a review from a team as a code owner July 28, 2026 15:00
@irenegaunab irenegaunab self-assigned this Jul 28, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

New or renamed files

@gh-worker-ownership-write-b05516
gh-worker-ownership-write-b05516 Bot removed the request for review from a team July 28, 2026 15:47
@datadog-datadog-prod-us1

datadog-datadog-prod-us1 Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Tests

🔄 Datadog auto-retried 1 job - 1 passed on retry View in Datadog

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 8869ea8 | Docs | Datadog PR Page | Give us feedback!

<div class="ddsql-schema-single">
{{ if eq .Params.status "deprecated" }}
<div class="alert alert-warning">
<strong>Deprecated</strong>: This table is deprecated and may return no data.

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.

super nit: the text was changed and the PR screenshot does not match the text anymore.

{{ partial "site_support_banner/site_support_banner.html" . }}

<div class="ddsql-schema-single">
{{ if eq .Params.status "deprecated" }}

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 found the place where we filter out non stable datasets and it's here. This logic should probably be updated to be "status == stable | deprecated" (ie allowlist of known supported statuses in case we want to add more statuses in the future).

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

Labels

Architecture Everything related to the Doc backend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants