Skip to content

docs: Wire up single-sourced Cloud Topics page#604

Merged
micheleRP merged 1 commit into
mainfrom
cloud-topics-single-source
May 29, 2026
Merged

docs: Wire up single-sourced Cloud Topics page#604
micheleRP merged 1 commit into
mainfrom
cloud-topics-single-source

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 29, 2026

What

The Cloud Topics page (develop/topics/cloud-topics.adoc) was rendering blank in production. It was never wired up for single-sourcing: it was still a placeholder stub with a // TODO comment and no include:: directive, so it had a title (appeared in nav) but no body.

This replaces the placeholder with an include of the source page in the streaming component (docs repo), matching the sibling configure-producers-for-cloud-topics.adoc page:

include::streaming:develop:manage-topics/cloud-topics.adoc[tag=single-source]

How it slipped through

  1. The source page was created in the docs repo while the component was still ROOT.
  2. The placeholder stub was added here with a TODO to wire it up "when streaming component has cloud-topics file."
  3. The docs repo component was renamed ROOT -> streaming, satisfying that condition.
  4. The sibling producers page was wired up, but this stub was forgotten.

Companion PR (required)

Verification

Built locally against the docs PR branch. The page renders in full (overview, Prerequisites, Limitations, Enable Cloud Topics), the cloud-only Prerequisites branch shows while self-managed-only content is excluded, and all outbound links resolve.

🤖 Generated with Claude Code

Preview pages

The cloud-docs Cloud Topics page was left as a placeholder stub and
never wired up for single-sourcing, so it rendered blank. Replace the
placeholder with an include of the source page in the streaming
component (docs repo), matching the sibling configure-producers page.

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 rp-cloud ready!

Name Link
🔨 Latest commit 07da21b
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a1998d4d9172b000849a934
😎 Deploy Preview https://deploy-preview-604--rp-cloud.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 the "Manage Cloud Topics" documentation page by replacing placeholder TODO comments with an include:: directive that pulls shared content from the canonical cloud topics source located in the streaming module (streaming:develop:manage-topics/cloud-topics.adoc with the single-source tag). This establishes a single-source-of-truth pattern for cloud topic management documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • redpanda-data/cloud-docs#526: Updates the shared single-source AsciiDoc for "Manage Cloud Topics" in the develop module, which this PR then includes from the new cloud-topics page.

Suggested reviewers

  • WillemKauf
  • dotnwat
  • Feediver1
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description lacks the required template structure with issue link, page preview link, and checkbox selection for change type. Add the missing template sections: GitHub issue link, page preview URL, and check the appropriate change type checkbox (Content gap appears most relevant here).
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: Wire up single-sourced Cloud Topics page' clearly and concisely describes the main change: replacing a placeholder with a single-source include directive for the Cloud Topics documentation page.
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.

✏️ 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-single-source

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

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.

lgtm

@micheleRP micheleRP merged commit 6f24a85 into main May 29, 2026
5 checks passed
@micheleRP micheleRP deleted the cloud-topics-single-source 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