Skip to content

docs: Fix cloud-divergent xrefs in single-sourced Cloud Topics content#1722

Merged
micheleRP merged 1 commit into
mainfrom
cloud-topics-cloud-xref-paths
May 29, 2026
Merged

docs: Fix cloud-divergent xrefs in single-sourced Cloud Topics content#1722
micheleRP merged 1 commit into
mainfrom
cloud-topics-cloud-xref-paths

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 29, 2026

What

Fixes two xrefs inside the single-sourced Cloud Topics content that pointed at paths which only exist in the self-managed docs, so they would resolve as broken links when the page is single-sourced into cloud-docs.

  • modules/develop/pages/manage-topics/cloud-topics.adoc: the producers-page link used develop:manage-topics/..., but cloud-docs serves that page at develop:topics/.... Now switched via an env-cloud attribute so each variant resolves.
  • modules/develop/partials/cloud-topics-overview.adoc: the env-cloud branch pointed at get-started:config-topics.adoc, but cloud-docs serves it at develop:topics/config-topics.adoc. Updated the cloud branch target.

Self-managed output is unchanged (both fixes are inside env-cloud guards / attribute switches).

Why

The cloud-docs Cloud Topics page was rendering blank because its stub was never wired up for single-sourcing. The companion cloud-docs PR wires it up; these xref fixes ensure the resulting page has no broken links.

Companion PR

Verification

Built cloud-docs locally against this branch. The Cloud Topics page renders in full, the cloud-only Prerequisites branch shows (self-managed-only content excluded), and all outbound links resolve to real cloud-docs pages.

🤖 Generated with Claude Code

Preview pages

When the Cloud Topics page is single-sourced into cloud-docs, two xrefs
pointed at paths that only exist in the self-managed docs:

- The producers-page link used develop:manage-topics/..., but cloud-docs
  serves that page at develop:topics/.... Switch the path via an
  env-cloud attribute so each variant resolves correctly.
- The overview partial's env-cloud branch pointed at
  get-started:config-topics.adoc, but cloud-docs serves it at
  develop:topics/config-topics.adoc. Update the cloud branch target.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP requested a review from a team as a code owner May 29, 2026 13:46
@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit fb36c7f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a1998c72b074b0008c9face
😎 Deploy Preview https://deploy-preview-1722--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 29, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates AsciiDoc documentation to implement environment-dependent routing for Cloud Topics configuration. The first file introduces conditional logic that selects the producer page reference based on the env-cloud build flag, using a producers-page attribute when cloud is enabled and a fallback path otherwise. The second file updates a documentation link within an env-cloud conditional block to point to a different module path. These changes align topic and producer configuration references to route users to the appropriate documentation depending on their build environment.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • redpanda-data/docs#1645: Both PRs update AsciiDoc env-cloud conditionals to route different xref targets for cloud vs non-cloud builds.
  • redpanda-data/docs#1329: Both PRs update AsciiDoc env-cloud conditional sections to route different documentation links based on the build environment.

Suggested reviewers

  • mattschumpert
  • paulohtb6
  • dotnwat
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main change: fixing cross-references in cloud-divergent, single-sourced Cloud Topics documentation.
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 The pull request description is comprehensive and well-structured, including what was changed, why, verification steps, and a companion PR reference.

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

✨ 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 cloud-topics-cloud-xref-paths

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (2)
modules/develop/pages/manage-topics/cloud-topics.adoc (1)

88-88: 💤 Low value

Consider using empty brackets to auto-pull the link title.

The xref uses hard-coded link text [Configure producers for Cloud Topics]. Per repository convention, prefer xref:{producers-page}[] with empty brackets so the title is pulled automatically from the referenced document.

♻️ Proposed refactor
-For client-side tuning guidance, see xref:{producers-page}[Configure producers for Cloud Topics].
+For client-side tuning guidance, see xref:{producers-page}[].

Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@modules/develop/pages/manage-topics/cloud-topics.adoc` at line 88, Replace
the hard-coded xref link text in the Cloud Topics page: locate the xref usage
xref:{producers-page}[Configure producers for Cloud Topics] and change it to use
empty brackets xref:{producers-page}[] so the title is auto-pulled from the
referenced document per repository convention.
modules/develop/partials/cloud-topics-overview.adoc (1)

4-4: 💤 Low value

Consider using empty brackets to auto-pull the link title.

The xref uses hard-coded link text [topics]. Per repository convention, prefer xref:develop:topics/config-topics.adoc[] with empty brackets so the title is pulled automatically from the referenced document.

♻️ Proposed refactor
-xref:develop:topics/config-topics.adoc[topics]
+xref:develop:topics/config-topics.adoc[]

Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@modules/develop/partials/cloud-topics-overview.adoc` at line 4, Replace the
hard-coded link text in the xref on the line containing
"xref:develop:topics/config-topics.adoc[topics]" with empty brackets so the
target document title is auto-pulled (i.e., change the reference to
"xref:develop:topics/config-topics.adoc[]"); update the single occurrence in the
file modules/develop/partials/cloud-topics-overview.adoc where that xref
appears.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@modules/develop/pages/manage-topics/cloud-topics.adoc`:
- Line 88: Replace the hard-coded xref link text in the Cloud Topics page:
locate the xref usage xref:{producers-page}[Configure producers for Cloud
Topics] and change it to use empty brackets xref:{producers-page}[] so the title
is auto-pulled from the referenced document per repository convention.

In `@modules/develop/partials/cloud-topics-overview.adoc`:
- Line 4: Replace the hard-coded link text in the xref on the line containing
"xref:develop:topics/config-topics.adoc[topics]" with empty brackets so the
target document title is auto-pulled (i.e., change the reference to
"xref:develop:topics/config-topics.adoc[]"); update the single occurrence in the
file modules/develop/partials/cloud-topics-overview.adoc where that xref
appears.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e82078de-0582-405b-81c8-1564e41ef543

📥 Commits

Reviewing files that changed from the base of the PR and between 19ade79 and fb36c7f.

📒 Files selected for processing (2)
  • modules/develop/pages/manage-topics/cloud-topics.adoc
  • modules/develop/partials/cloud-topics-overview.adoc

@micheleRP micheleRP merged commit 7b6420c into main May 29, 2026
7 checks passed
@micheleRP micheleRP deleted the cloud-topics-cloud-xref-paths branch May 29, 2026 14:02
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