docs: Fix cloud-divergent xrefs in single-sourced Cloud Topics content#1722
Conversation
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>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis 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 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 docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
modules/develop/pages/manage-topics/cloud-topics.adoc (1)
88-88: 💤 Low valueConsider using empty brackets to auto-pull the link title.
The xref uses hard-coded link text
[Configure producers for Cloud Topics]. Per repository convention, preferxref:{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 valueConsider using empty brackets to auto-pull the link title.
The xref uses hard-coded link text
[topics]. Per repository convention, preferxref: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
📒 Files selected for processing (2)
modules/develop/pages/manage-topics/cloud-topics.adocmodules/develop/partials/cloud-topics-overview.adoc
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 useddevelop:manage-topics/..., but cloud-docs serves that page atdevelop:topics/.... Now switched via anenv-cloudattribute so each variant resolves.modules/develop/partials/cloud-topics-overview.adoc: theenv-cloudbranch pointed atget-started:config-topics.adoc, but cloud-docs serves it atdevelop:topics/config-topics.adoc. Updated the cloud branch target.Self-managed output is unchanged (both fixes are inside
env-cloudguards / 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