Conversation
…pics - Update Develop navtree to mirror self-managed structure: Topics parent (develop:manage-topics/index.adoc) with Manage Topics and Cloud Topics as children - Remove create-topic.adoc as a standalone nav entry - Merge create-topic.adoc content into config-topics.adoc as the first section (== Create a Topic), with page-aliases to preserve old URLs - Add develop:manage-topics/cloud-topics.adoc to the navtree after Manage Topics for single-sourced Cloud Topics content Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
👷 Deploy Preview for rp-cloud processing.
|
|
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 pull request reorganizes navigation structure for documentation topics and updates topic configuration content. The navigation changes move "Create a Topic" and "Manage Topics" from a flat Get Started grouping into a two-level Develop/Manage-Topics hierarchy. Additionally, the config-topics.adoc file is expanded with a new "Create a Topic" section that includes topic properties specifications, a properties table, and external warning/notes fragments. No code changes or exported entity modifications are involved. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Content merged into config-topics.adoc as == Create a Topic section. Page aliases on config-topics.adoc handle redirect from old URL. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
modules/get-started/pages/config-topics.adoc (1)
13-15: Consider using native AsciiDoc spacing.The HTML
<br>passthrough is valid but AsciiDoc has native spacing options. Consider using blank lines or the[%hardbreaks]attribute instead of HTML passthroughs for better portability.♻️ Alternative approach using native AsciiDoc
Replace the HTML passthrough with a blank line:
-++++ -<br> -++++ - + [cols="1,2"]Or keep the HTML if precise spacing control is required for the rendered output.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/get-started/pages/config-topics.adoc` around lines 13 - 15, Replace the HTML passthrough <br> in the config-topics.adoc snippet with native AsciiDoc spacing: remove the <br> and use a blank line to create a paragraph break, or if you need hard breaks throughout the block add the [%hardbreaks] attribute to the section header or adjacent block; update the text surrounding the <br> occurrence so it renders correctly with the chosen AsciiDoc spacing option.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@modules/get-started/pages/config-topics.adoc`:
- Around line 13-15: Replace the HTML passthrough <br> in the config-topics.adoc
snippet with native AsciiDoc spacing: remove the <br> and use a blank line to
create a paragraph break, or if you need hard breaks throughout the block add
the [%hardbreaks] attribute to the section header or adjacent block; update the
text surrounding the <br> occurrence so it renders correctly with the chosen
AsciiDoc spacing option.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 9df86682-fa7c-486e-aa61-e9c7e3da2cb0
📒 Files selected for processing (2)
modules/ROOT/nav.adocmodules/get-started/pages/config-topics.adoc
Cross-component xrefs don't resolve titles automatically in the cloud-docs build. Add explicit labels to prevent raw page IDs from appearing in the navtree. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Creates get-started:topics-index.adoc as a cloud-docs-specific index for the Topics section, listing Manage Topics and Cloud Topics with one-sentence descriptions. Updates the nav to reference the local page instead of the cross-component develop:manage-topics/index.adoc, which was causing the raw page ID to display in the navtree. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Updates Manage Topics and Cloud Topics descriptions per editorial feedback. Removes page-layout: index which was auto-generating a duplicate Manage Topics card at the bottom of the page. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Single-sources content from ROOT:develop:manage-topics/cloud-topics.adoc (redpanda-data/docs PR #1469) using the same include pattern as other develop module pages in cloud-docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The include::ROOT:develop:manage-topics/cloud-topics.adoc approach requires redpanda-data/docs PR #1469 to merge first. Until then, include the content directly with single-source tags. Self-managed-only prereqs (Tiered Storage, Enterprise license, Docker) are excluded since they don't apply to Cloud. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…include path - Create develop:manage-topics/cloud-topics.adoc wrapper that includes single-source content from docs repo - Update config-topics.adoc include path to match new manage-topics/ directory structure Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The page alias conflicts with the actual create-topic.adoc file on main during Netlify's merge-based preview builds. The alias can be re-added after this PR merges and the file is deleted from main. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Closing and using #526 instead. |
Summary
develop:manage-topics/index.adoc) with Manage Topics and Cloud Topics as childrencreate-topic.adocas a standalone nav entrycreate-topic.adocintoconfig-topics.adocas the first section (== Create a Topic), withpage-aliasesto preserve old URLs forget-started:create-topic.adocandcloud:create-topic.adocdevelop:manage-topics/cloud-topics.adocto the navtree after Manage Topics for the single-sourced Cloud Topics contentTest plan
/create-topicURL redirects correctly via page-aliases🤖 Generated with Claude Code