Skip to content

Hide self-managed release notes prerequisite from cloud build#1707

Merged
micheleRP merged 4 commits into
mainfrom
fix-schema-reg-contexts-cloud-xrefs
May 18, 2026
Merged

Hide self-managed release notes prerequisite from cloud build#1707
micheleRP merged 4 commits into
mainfrom
fix-schema-reg-contexts-cloud-xrefs

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 18, 2026

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 to xref:get-started:release-notes/redpanda.adoc[], which exists in the ROOT (self-managed) component but not in redpanda-cloud. When modules/manage/pages/schema-reg/schema-reg-contexts.adoc is single-sourced into cloud-docs via include::ROOT:manage:schema-reg/schema-reg-contexts.adoc[tag=single-source], the xref resolves against redpanda-cloud and 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.adoc that point at pages that exist only in the self-managed ROOT component. Three xrefs broke the cloud-docs build:

  1. xref:get-started:release-notes/redpanda.adoc[] — fixed in this PR.
  2. 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).
  3. 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

  • Cloud-docs local build (with this branch as the docs source) confirms the three Schema Registry contexts xref errors are gone.
  • Self-managed standalone build still renders the prerequisite bullet on the page.

🤖 Generated with Claude Code

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>
@micheleRP micheleRP requested a review from a team as a code owner May 18, 2026 02:30
@micheleRP micheleRP requested a review from Feediver1 May 18, 2026 02:30
@netlify
Copy link
Copy Markdown

netlify Bot commented May 18, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 09e0ba2
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a0b4ab598f63100085bd06b
😎 Deploy Preview https://deploy-preview-1707--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b6967273-acc6-4617-a2ae-94130fb06d8e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This 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 ifndef::env-cloud[] directives. The change applies only to non-cloud deployments, reflecting that this version requirement does not apply in the managed Redpanda Cloud environment.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • redpanda-data/docs#1326: Adds identical ifndef::env-cloud[] conditionals to exclude prerequisite bullets in the same Schema Registry documentation module.
  • redpanda-data/docs#1107: Applies AsciiDoc conditionals to hide cloud-specific content, similar pattern of gating prerequisites based on build environment.
  • redpanda-data/docs#1645: Uses the same ifndef::env-cloud[] conditional approach to differentiate prerequisites between cloud and non-cloud documentation builds.

Suggested reviewers

  • Feediver1
  • paulohtb6
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: wrapping a self-managed prerequisite in a conditional to hide it from the cloud build.
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.
Description check ✅ Passed PR description is comprehensive with detailed context, rationale, and test plan; exceeds template requirements.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-schema-reg-contexts-cloud-xrefs

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

@Feediver1
Copy link
Copy Markdown
Contributor

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
pre-existing bug a few hundred lines down that the user (you) introduced in #1658 that this PR misses.


Issues found

🟢 The intended fix (lines 65–67) — clean

ifndef::env-cloud[]

  • You are running xref:get-started:release-notes/redpanda.adoc[Redpanda v26.1] or later.
    endif::[]

Verified:

  • modules/get-started/pages/release-notes/redpanda.adoc exists in redpanda-data/docs ✓
  • Doesn't exist in redpanda-data/cloud-docs (correctly hidden behind ifndef::env-cloud[]) ✓
  • Conditional preprocessor strips lines 65–67 cleanly in cloud build — the next bullet on line 68 stands alone, and the + / [IMPORTANT]
    continuation on lines 69–73 still attaches to it. No list-break risk.

🔴 Pre-existing bug at lines 781–786 — not addressed by this PR but in the same file

ifndef::env-cloud[]

  • xref:reference:cluster-properties.adoc[] ← short path, doesn't exist anywhere
    endif::env-cloud[]
    ifdef::env-cloud[]
  • xref:reference:properties/cluster-properties.adoc[] ← long path, exists in both repos
    endif::env-cloud[]

I confirmed via the GitHub API:

  • modules/reference/pages/cluster-properties.adoc — 404 in both redpanda-data/docs AND redpanda-data/cloud-docs
  • modules/reference/pages/properties/cluster-properties.adoc — exists in both

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
mode (broken xrefs render rather than fail), but it's still publishing a broken link in production self-managed docs. The whole
conditional block here is dead weight — both builds use the same long path. It should collapse to a single unconditional line:

  • xref:reference:properties/cluster-properties.adoc[]

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::[]:
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
for non-nested conditionals, but for consistency the named form is preferred. Trivial — not a blocker.

🟡 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:

┌─────────────────┬───────────────┬─────────────────┬───────┐
│ │ State │ Approval │ CI │
├─────────────────┼───────────────┼─────────────────┼───────┤
│ docs #1707 │ OPEN, BLOCKED │ not approved │ green │
├─────────────────┼───────────────┼─────────────────┼───────┤
│ cloud-docs #588 │ OPEN, BLOCKED │ REVIEW_REQUIRED │ green │
└─────────────────┴───────────────┴─────────────────┴───────┘

If only #1707 merges, the next cloud-docs build still breaks on the two rpk-registry-context-{list,delete} xrefs. If only #588 merges,
cloud-docs build still breaks on the release-notes xref. Reviewers on either PR should be aware they need to coordinate or the cloud build
stays red between 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"
is unchecked. Mechanically the change is safe in self-managed (the bullet renders because ifndef::env-cloud[] is true), but worth
confirming on the Netlify preview before merge — that takes 30 seconds at
https://deploy-preview-1707--redpanda-docs-preview.netlify.app/current/manage/schema-reg/schema-reg-contexts/.

⚪ Other xrefs I sanity-checked — all OK

  • Line 68 xref:reference:properties/cluster-properties.adoc#schema_registry_enable_qualified_subjects (unconditional, anchor) — long path,
    exists in both repos ✓
  • Line 620, 780 xref:reference:public-metrics-reference.adoc[] — page exists in both ✓
  • Lines 489–498 (10 rpk-registry xrefs) — confirmed each page exists in both docs and cloud-docs modules/reference/pages/rpk/rpk-registry/
  • Lines 776–778 (manage xrefs inside same module) — internal, fine ✓

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
cluster-properties.adoc paths) since that's a real broken link on the live self-managed docs page right now. Coordinate the merge timing
of #1707 and cloud-docs #588 so cloud's next build is fully green.

Copy link
Copy Markdown
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

No blockers!
Looks like 588 will clear up the rest.

My apologies for this extra work!

micheleRP and others added 2 commits May 18, 2026 11:17
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>
@micheleRP micheleRP merged commit e4571c6 into main May 18, 2026
7 checks passed
@micheleRP micheleRP deleted the fix-schema-reg-contexts-cloud-xrefs branch May 18, 2026 18:29
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.

2 participants