Hide self-managed release notes prerequisite from cloud build#1707
Conversation
The xref to get-started:release-notes/redpanda.adoc inside the single-sourced Schema Registry contexts page broke the cloud-docs build (the target page only exists in the self-managed component). The "Redpanda v26.1 or later" prerequisite also doesn't apply to cloud users since Redpanda Cloud manages versions for them. Wrap the bullet in ifndef::env-cloud[] so it appears only in the self-managed build. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR adds an AsciiDoc conditional to the Schema Registry documentation. The prerequisite bullet stating that users must run Redpanda v26.1 or later is now excluded from Redpanda Cloud builds by wrapping it with Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Here is Claude's review: Here's my review of PR #1707, ordered by impact. Quick verdict: the change itself is correct and safe to merge, but there's a real Issues found 🟢 The intended fix (lines 65–67) — clean ifndef::env-cloud[]
Verified:
🔴 Pre-existing bug at lines 781–786 — not addressed by this PR but in the same file ifndef::env-cloud[]
I confirmed via the GitHub API:
So in the self-managed build, line 782 renders an xref to a page that doesn't exist. CI on PR #1707 is green, so Antora must be in lenient
This bug came in via your #1658. Worth a follow-up PR (or a one-line addition to #1707 if Michele is willing to expand scope). 🟡 Minor style inconsistency — line 67 The new code uses unnamed endif::[]: But every other endif in this file uses the named form (endif::env-cloud[], e.g. line 783). Both are valid AsciiDoc and behave identically 🟡 Cross-repo dependency — order/timing The PR body correctly identifies that #1707 + cloud-docs #588 must both land before the cloud build is fully fixed. Status right now: ┌─────────────────┬───────────────┬─────────────────┬───────┐ If only #1707 merges, the next cloud-docs build still breaks on the two rpk-registry-context-{list,delete} xrefs. If only #588 merges, 🟡 Unchecked test plan item The PR's test plan has the cloud-docs build verified but "Self-managed standalone build still renders the prerequisite bullet on the page" ⚪ Other xrefs I sanity-checked — all OK
Recommendation Approve and merge #1707 as-is — it does what it claims, accurately. Then open a one-line follow-up PR to fix lines 781–786 (the inverted |
Feediver1
left a comment
There was a problem hiding this comment.
No blockers!
Looks like 588 will clear up the rest.
My apologies for this extra work!
Two follow-ups from PR review: - Line 67: use the named `endif::env-cloud[]` form to match the rest of the file. - Lines 781-786: collapse the related_topics conditional that pointed to a non-existent `reference:cluster-properties.adoc` (short path) in the self-managed branch. Both repos only have the long path at `reference:properties/cluster-properties.adoc`, so the conditional is dead weight and produced a broken xref on the live self-managed page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Summary
Wraps the "Redpanda v26.1 or later" prerequisite bullet on the Schema Registry contexts page in
ifndef::env-cloud[]so it appears only in the self-managed build. The bullet links toxref:get-started:release-notes/redpanda.adoc[], which exists in theROOT(self-managed) component but not inredpanda-cloud. Whenmodules/manage/pages/schema-reg/schema-reg-contexts.adocis single-sourced into cloud-docs viainclude::ROOT:manage:schema-reg/schema-reg-contexts.adoc[tag=single-source], the xref resolves againstredpanda-cloudand breaks the cloud-docs build. The version prerequisite also doesn't apply to cloud users — Redpanda Cloud manages versions.Why this fix is needed
@Feediver1 — your recent PRs #1658 (DOC-1996: Schema Registry Contexts) and #1690 (DOC-1790: Schema Registry Metadata Properties) introduced xrefs inside the single-sourced section of
modules/manage/pages/schema-reg/schema-reg-contexts.adocthat point at pages that exist only in the self-managedROOTcomponent. Three xrefs broke the cloud-docs build:xref:get-started:release-notes/redpanda.adoc[]— fixed in this PR.xref:reference:rpk/rpk-registry/rpk-registry-context-list.adoc[]— fixed in the companion cloud-docs PR Add rpk registry context reference pages cloud-docs#588 (adds wrapper pages).xref:reference:rpk/rpk-registry/rpk-registry-context-delete.adoc[]— fixed in the companion cloud-docs PR Add rpk registry context reference pages cloud-docs#588 (adds wrapper pages).In Antora, xrefs inside included content resolve in the including page's component, not the source component. For pages that exist only in the self-managed component, the xref must either be wrapped in
ifndef::env-cloud[](this PR) or, if the linked content is cloud-relevant, a wrapper page must be added on the cloud-docs side (the companion PR).Preview pages
Test plan
🤖 Generated with Claude Code