Skip to content

DOCS-1602: Cloud Topics#525

Closed
Feediver1 wants to merge 14 commits intomainfrom
DOC-1602
Closed

DOCS-1602: Cloud Topics#525
Feediver1 wants to merge 14 commits intomainfrom
DOC-1602

Conversation

@Feediver1
Copy link
Contributor

Summary

  • Updates the Develop navtree to mirror the self-managed docs structure: a Topics parent (develop:manage-topics/index.adoc) with Manage Topics and Cloud Topics as children
  • Removes create-topic.adoc as a standalone nav entry
  • Merges the content from create-topic.adoc into config-topics.adoc as the first section (== Create a Topic), with page-aliases to preserve old URLs for get-started:create-topic.adoc and cloud:create-topic.adoc
  • Adds develop:manage-topics/cloud-topics.adoc to the navtree after Manage Topics for the single-sourced Cloud Topics content

Test plan

  • Verify navtree shows Topics > Manage Topics and Topics > Cloud Topics under Develop
  • Verify old /create-topic URL redirects correctly via page-aliases
  • Verify Create a Topic section appears at the top of Manage Topics page
  • Verify Cloud Topics content renders correctly from the single-sourced include

🤖 Generated with Claude Code

…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>
@Feediver1 Feediver1 requested a review from a team as a code owner March 12, 2026 03:03
@netlify
Copy link

netlify bot commented Mar 12, 2026

👷 Deploy Preview for rp-cloud processing.

Name Link
🔨 Latest commit f46200d
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/69b22f31c7df5c000864a1e4

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 12, 2026

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: 5971e973-eccf-4d4e-a3a8-a4cb6c081a2a

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

  • micheleRP
  • mattschumpert
  • ballard26
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'DOCS-1602: Cloud Topics' directly references the issue and the main feature being added, accurately reflecting the primary change in the PR.
Description check ✅ Passed The PR description is substantially complete, providing clear summary of changes, rationale, and a detailed test plan. However, it lacks the template's required sections: issue link, review deadline, and page previews.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1602

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

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>
Copy link
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 (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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b86448 and 95805b2.

📒 Files selected for processing (2)
  • modules/ROOT/nav.adoc
  • modules/get-started/pages/config-topics.adoc

Feediver1 and others added 3 commits March 11, 2026 23:12
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>
@Feediver1 Feediver1 marked this pull request as draft March 12, 2026 03:32
@Feediver1 Feediver1 marked this pull request as ready for review March 12, 2026 03:32
@Feediver1 Feediver1 closed this Mar 12, 2026
@Feediver1 Feediver1 reopened this Mar 12, 2026
Feediver1 and others added 9 commits March 11, 2026 23:49
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>
@Feediver1
Copy link
Contributor Author

Closing and using #526 instead.

@Feediver1 Feediver1 closed this Mar 12, 2026
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