Skip to content

Add support disclaimer to Preview badge tooltip#401

Merged
micheleRP merged 4 commits into
mainfrom
preview-badge-tooltip-support-note
Jul 16, 2026
Merged

Add support disclaimer to Preview badge tooltip#401
micheleRP merged 4 commits into
mainfrom
preview-badge-tooltip-support-note

Conversation

@micheleRP

@micheleRP micheleRP commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

What

Updates the default Preview badge tooltip text to add a support disclaimer.

Before: "This feature is in preview and may change."
After: "This feature is in preview and may change. Features in preview are not covered by Enterprise Support, SLAs, or the standard Redpanda Support process."

Where

  • src/partials/article.hbs — the {{else}} fallback for the Preview status badge. Per-page preview-text overrides are unaffected.
  • preview-src/preview-status-test.adoc — badge test fixture updated to match the new default text.

Notes

  • Site-wide change: affects the Preview badge on every page across docs.redpanda.com, not just Agentic Data Plane pages.
  • beta and Limited Availability tooltips are unchanged.
  • Requires a docs-ui version bump + release for consuming repos to pick it up (not included here).

🤖 Generated with Claude Code

Update the default Preview badge tooltip to note that preview features
are not supported by Redpanda. Per-page `preview-text` overrides are
unaffected.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@netlify

netlify Bot commented Jul 16, 2026

Copy link
Copy Markdown

Deploy Preview for docs-ui ready!

Name Link
🔨 Latest commit a3727f2
🔍 Latest deploy log https://app.netlify.com/projects/docs-ui/deploys/6a59514616a84c0008e7bfb1
😎 Deploy Preview https://deploy-preview-401--docs-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 27 (🔴 down 4 from production)
Accessibility: 89 (no change from production)
Best Practices: 92 (no change from production)
SEO: 89 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The sticky article header’s Preview status badge now includes an additional sentence in its default tooltip stating that preview features are not supported by Redpanda. The page.attributes.preview-text override behavior remains unchanged.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested reviewers: jakescahill

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly matches the main change: adding a support disclaimer to the Preview badge tooltip.
Description check ✅ Passed The description accurately describes the tooltip text update and related unaffected overrides.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch preview-badge-tooltip-support-note

Comment @coderabbitai help to get the list of available commands.

micheleRP and others added 2 commits July 16, 2026 15:21
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@wzzzrd86 wzzzrd86 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM!

@Feediver1 Feediver1 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.

Final-pass review (docs-team-standards)

Overall: Correct, minimal change with the right scoping (fallback text only, per-page preview-text overrides untouched). Nothing blocking; one stale test fixture and two consistency questions worth settling before release.

Critical issues

None. The template logic is untouched (only the {{else}} literal changed), the text contains no characters that would break the data-tippy-content attribute, and per-page overrides still win.

Suggestions

  1. [preview-src/preview-status-test.adoc:16] Stale test fixture. The repo's own badge test page documents the default tooltip as "This feature is in preview and may change." — now outdated. Anyone using that page to verify the badge will see the fixture contradict the rendered tooltip. One-line update.
  2. [Consistency with beta] Asymmetric disclaimers. cloud-docs (get-started/pages/cloud-overview.adoc:397) states that beta features "are not covered by Redpanda Support and should not be used in production environments," yet the beta tooltip keeps the generic "may change" text. After this PR, the earlier-stage badge (Preview) carries a support disclaimer while beta doesn't, even though published docs say beta is also unsupported. The PR body says this is deliberate — worth confirming that's a decision rather than an omission, or giving beta the same treatment in a follow-up.
  3. [Wording provenance] Confirm the phrasing against the official support policy. "Enterprise Support, SLAs, or the standard Redpanda support process" reads as a quasi-contractual statement rendered on every preview page. If Support/legal has canonical language for preview-tier coverage, this string should match it verbatim (note the existing cloud-overview wording says "Redpanda Support" rather than "Enterprise Support").
  4. [Discoverability] Tooltips are hover-only. Touch and screen-reader users may never encounter data-tippy-content. Not blocking — but if the disclaimer is load-bearing, an on-page admonition or a linked support-tiers page is the durable home.

Impact

  • Consuming repos see nothing until a docs-ui version bump + release (correctly flagged in the PR body as out of scope) — confirm that follow-up is tracked so this doesn't silently sit unreleased.
  • No other copies of the default string exist in the repo (only the template and the test fixture above).

What works well

  • Smallest possible diff for a site-wide copy change; the {{else}} placement preserves every existing per-page override
  • Exemplary PR body: before/after, blast radius, what's deliberately unchanged, and the release dependency all stated

🤖 Automated final-pass review via docs-team-standards pr-review.

@Feediver1 Feediver1 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.

lgtm

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@micheleRP
micheleRP merged commit 2fc06ea into main Jul 16, 2026
6 checks passed
@micheleRP
micheleRP deleted the preview-badge-tooltip-support-note branch July 16, 2026 21:50
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.

3 participants