Add support disclaimer to Preview badge tooltip#401
Conversation
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>
✅ Deploy Preview for docs-ui ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe 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 Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Feediver1
left a comment
There was a problem hiding this comment.
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
- [
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. - [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. - [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").
- [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.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

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-pagepreview-textoverrides are unaffected.preview-src/preview-status-test.adoc— badge test fixture updated to match the new default text.Notes
🤖 Generated with Claude Code