Merged
Conversation
Co-authored-by: Gellért Peresztegi-Nagy <gellert.nagy@redpanda.com> Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Kat Batuigas <kbatuigas@gmail.com>
…fixes (#1630) Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Nicolae Vartolomei <nv@redpanda.com> Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
- Merge all commits from main (20 commits) - Resolve conflicts: keep v-WIP/26.1 version and release notes - Update antora.yml with v26.1.1 release information: - latest-redpanda-tag: v26.1.1 - latest-release-commit: 35a825c9c1880ebeedf4c18bb8c6cceaa63566c1 - full-version: 26.1.1 - page-release-date: 2026-03-31 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
…_time (#1607) Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: JakeSCahill <jake@redpanda.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: JakeSCahill <jake@redpanda.com> Co-authored-by: Michele Cyran <michele@redpanda.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Michele Cyran <michele@redpanda.com>
…1628) Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com> Co-authored-by: JakeSCahill <jake@redpanda.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
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 updates the Redpanda documentation site for v26.1.1 release. It bumps site metadata from version 25.3 to 26.1, restructures the documentation navigation to organize topic management under a new "Manage Topics" section with dedicated Cloud Topics guidance, adds comprehensive documentation for new features including Group-Based Access Control (GBAC) and Cloud Topics configuration, updates numerous cross-references throughout the documentation, refreshes configuration property metadata to reflect v26.1.1 capabilities, and removes deprecated property documentation from earlier versions. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Co-authored-by: JakeSCahill <jake@redpanda.com>
…single-sourcing (#1641) Co-authored-by: david-yu <david.yu@redpanda.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: David Yu <yongshinyu@gmail.com> Co-authored-by: Michele Cyran <michele@redpanda.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 16
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
modules/reference/partials/properties/topic-properties.adoc (1)
947-988:⚠️ Potential issue | 🔴 CriticalCorrect the anchor reference for
redpanda.storage.modeLine 952 uses an incorrect anchor reference
<<redpandastorage-mode>>that will create a broken link. The heading at line 1559 (=== redpanda.storage.mode) auto-generates the anchorredpanda-storage-mode(with hyphens replacing the dot). The reference should be updated to<<redpanda-storage-mode,redpanda.storage.mode>>to match the auto-generated anchor.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/reference/partials/properties/topic-properties.adoc` around lines 947 - 988, Update the broken AsciiDoc anchor reference for the redpanda.storage.mode property: replace the incorrect inline anchor reference `<<redpandastorage-mode, `redpanda.storage.mode`>>` (used in the Topic properties section/`redpanda.cloud_topic.enabled` doc block) with the correct auto-generated anchor `<<redpanda-storage-mode, `redpanda.storage.mode`>>` so it matches the heading `=== redpanda.storage.mode`'s hyphenated anchor.
🧹 Nitpick comments (10)
modules/manage/partials/remote-read-replicas.adoc (2)
473-473: Consider adding URL examples for clarity.The note explains how the endpoint is used differently for
virtual_hostvspathURL styles, but concrete examples would make this clearer. Consider adding examples like:
- virtual_host style:
s3.us-east-1.amazonaws.com→my-bucket.s3.us-east-1.amazonaws.com- path style:
s3.us-east-1.amazonaws.com→s3.us-east-1.amazonaws.com/my-bucketThis would help users verify they've configured the endpoint correctly.
📝 Enhanced note with examples
-NOTE: The `endpoint` value must not include the bucket name. When using `virtual_host` URL style, Redpanda automatically prepends the bucket name to the endpoint. When using `path` URL style, Redpanda appends the bucket name as a path segment. +NOTE: The `endpoint` value must not include the bucket name. When using `virtual_host` URL style, Redpanda automatically prepends the bucket name to the endpoint (e.g., `s3.us-east-1.amazonaws.com` becomes `my-bucket.s3.us-east-1.amazonaws.com`). When using `path` URL style, Redpanda appends the bucket name as a path segment (e.g., `s3.us-east-1.amazonaws.com` becomes `s3.us-east-1.amazonaws.com/my-bucket`).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/partials/remote-read-replicas.adoc` at line 473, Update the NOTE about endpoint usage to include concrete examples showing how the bucket is applied for each URL style: add a clear virtual_host example like "s3.us-east-1.amazonaws.com → my-bucket.s3.us-east-1.amazonaws.com" and a path example like "s3.us-east-1.amazonaws.com → s3.us-east-1.amazonaws.com/my-bucket", and ensure the examples appear next to the existing mention of `endpoint`, `virtual_host`, and `path` URL styles in the same paragraph so users can quickly verify their configuration.
475-482: Consider defining "target" before explaining limits.The section introduces the term "object storage target" without prior definition, which might confuse users. Consider adding a brief definition before explaining how targets are counted.
📝 Add target definition
==== Limits -Each unique combination of region and endpoint creates a separate object storage target on the remote cluster. A cluster supports a maximum of 10 targets. +Each unique combination of region and endpoint creates a separate object storage target on the remote cluster. An object storage target represents a distinct backend connection for retrieving Remote Read Replica data. A cluster supports a maximum of 10 targets.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/partials/remote-read-replicas.adoc` around lines 475 - 482, Add a short definition for "object storage target" before the "Limits" header: state that a target represents a distinct object storage configuration used by a remote cluster (combination of bucket, region, and endpoint or just region+endpoint depending on cloud_storage_url_style). Then keep the existing explanation showing how targets are counted, referencing the config key `cloud_storage_url_style` and the two modes `virtual_host` and `path` so readers understand why counting differs.modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc (1)
223-223: Prefer empty-bracket xref for title consistency.Use
xref:develop:manage-topics/config-topics.adoc[]and let the linked page title render automatically.Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets ... Avoid hard-coding link text; use xref:...[] ..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc` at line 223, Replace the hard-coded xref link text "* xref:develop:manage-topics/config-topics.adoc[Manage Topics] - Create and manage topics" with an empty-bracket xref so the target page title is used automatically; update the string to use "xref:develop:manage-topics/config-topics.adoc[]" and remove the manual "Manage Topics - Create and manage topics" suffix so the linked page title renders consistently.modules/deploy/pages/redpanda/manual/production/dev-deployment.adoc (1)
11-11: Minor xref style cleanup recommended.Consider
xref:develop:manage-topics/config-topics.adoc#configure-write-caching[]to keep link text sourced from the target page title.Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets ... Avoid hard-coding link text; use xref:...[] ..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/deploy/pages/redpanda/manual/production/dev-deployment.adoc` at line 11, The xref link uses explicit link text instead of letting AsciiDoc pull the target title; update the link xref:develop:manage-topics/config-topics.adoc#configure-write-caching[write caching] to use empty brackets xref:develop:manage-topics/config-topics.adoc#configure-write-caching[] so the link text is sourced from the target page title (edit the sentence in dev-deployment.adoc where that xref appears).modules/manage/pages/kubernetes/k-schema-controller.adoc (1)
281-281: Prefer empty-bracket xref here for consistency.Use
xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[]instead of hard-coding the link text, so the title stays source-of-truth and consistent with repo style.Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets ... Avoid hard-coding link text; use xref:...[] ..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/pages/kubernetes/k-schema-controller.adoc` at line 281, Replace the hard-coded link text in the xref call for the Schema Registry ACLs reference so the target title remains the source-of-truth: locate the xref instance `xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[Manage Schema Registry ACLs (Operator)]` in k-schema-controller.adoc and change it to use empty brackets (`...[]`) so it becomes `xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[]`.modules/get-started/pages/quick-start.adoc (1)
448-448: Use empty-bracket xref to avoid hard-coded title text.Please switch to
xref:develop:manage-topics/config-topics.adoc#choose-the-replication-factor[]for consistency with repo linking conventions.Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets ... Avoid hard-coding link text; use xref:...[] ..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/get-started/pages/quick-start.adoc` at line 448, Replace the hard-coded xref text in modules/get-started/pages/quick-start.adoc by changing the link xref:develop:manage-topics/config-topics.adoc#choose-the-replication-factor[Choose the replication factor] to use empty brackets xref:develop:manage-topics/config-topics.adoc#choose-the-replication-factor[] so the rendered link text is not hard-coded; update the single occurrence that contains "choose-the-replication-factor" in the file.modules/manage/partials/authentication.adoc (1)
870-870: Good content addition; consider standard xref style.Please consider
xref:manage:security/authorization/gbac.adoc[]to keep link text auto-synced with the destination title.Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets ... Avoid hard-coding link text; use xref:...[] ..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/partials/authentication.adoc` at line 870, Replace the hard-coded AsciiDoc link xref:manage:security/authorization/gbac.adoc[group-based access control (GBAC)] with the preferred xref form xref:manage:security/authorization/gbac.adoc[] so the link text is auto-synced to the destination title; update the TIP line that mentions GBAC to use xref:manage:security/authorization/gbac.adoc[] and leave the surrounding sentence and example (the `groups` claim) unchanged.modules/upgrade/pages/k-compatibility.adoc (1)
22-22: Consider updating the example to use version 26.1.xThe example still references Redpanda Operator version 25.3.1. For v26.1 documentation, consider updating this to use a 26.1.x example (e.g., "Redpanda Operator version 26.1.1 supports Redpanda core versions 27.1.x, 26.1.x, and 25.3.x") to better align with the current release and provide a more intuitive example for readers.
While the current example is technically accurate (showing backward compatibility where 25.3.1 supports 26.1.x), it may confuse readers expecting to see the latest version as the primary example.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/upgrade/pages/k-compatibility.adoc` at line 22, Update the example to use the current 26.1 series instead of 25.3.1: replace the sentence that currently reads "Redpanda Operator version 25.3.1 supports Redpanda core versions 26.1.x, 25.3.x, and 25.2.x" with a 26.1 example such as "Redpanda Operator version 26.1.1 supports Redpanda core versions 27.1.x, 26.1.x, and 25.3.x" so the operator version and its listed supported core versions align with the v26.1 documentation.modules/get-started/pages/release-notes/redpanda.adoc (2)
50-50: Consider using empty brackets for the xref.Similar to line 13, this xref could use empty brackets to automatically pull the title. Based on learnings, prefer xref links with empty brackets when linking to the document title.
♻️ Simplified xref syntax
-xref:develop:produce-data/leader-pinning.adoc[Leader Pinning] now supports the `ordered_racks` configuration value, which lets you specify preferred racks in priority order. Unlike `racks`, which distributes leaders uniformly across all listed racks, `ordered_racks` places leaders in the highest-priority available rack and fails over to subsequent racks only when higher-priority racks become unavailable. +xref:develop:produce-data/leader-pinning.adoc[] now supports the `ordered_racks` configuration value, which lets you specify preferred racks in priority order. Unlike `racks`, which distributes leaders uniformly across all listed racks, `ordered_racks` places leaders in the highest-priority available rack and fails over to subsequent racks only when higher-priority racks become unavailable.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/get-started/pages/release-notes/redpanda.adoc` at line 50, The xref to the Leader Pinning doc uses an explicit title; change xref:develop:produce-data/leader-pinning.adoc[Leader Pinning] to use empty brackets (xref:develop:produce-data/leader-pinning.adoc[]) so the title is pulled automatically (same style as the other xref on line 13); update the single occurrence in the sentence about ordered_racks to use the empty-bracket xref.
13-13: Consider using empty brackets for the xref.The xref on line 13 could use empty brackets to automatically pull the title from the target document, following the repository's preferred pattern. Based on learnings, AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically.
♻️ Simplified xref syntax
-xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] are now available, making it possible to use durable cloud storage (S3, ADLS, GCS) as the primary backing store instead of local disk, eliminating over 90% of cross-AZ replication costs. This makes them ideal for latency-tolerant, high-throughput workloads such as observability streams, analytics pipelines, and AI/ML training data feeds, where cross-AZ networking charges are the dominant cost driver. +xref:develop:manage-topics/cloud-topics.adoc[] are now available, making it possible to use durable cloud storage (S3, ADLS, GCS) as the primary backing store instead of local disk, eliminating over 90% of cross-AZ replication costs. This makes them ideal for latency-tolerant, high-throughput workloads such as observability streams, analytics pipelines, and AI/ML training data feeds, where cross-AZ networking charges are the dominant cost driver.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/get-started/pages/release-notes/redpanda.adoc` at line 13, Replace the explicit link text in the xref call so the target document's title is pulled automatically; change the xref reference xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] to use empty brackets xref:develop:manage-topics/cloud-topics.adoc[] (i.e., update the xref on the line containing xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] to xref:develop:manage-topics/cloud-topics.adoc[]).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs-data/property-overrides.json`:
- Around line 1839-1843: The related_topics array for the property
default_topic_replication contains a duplicate link entry; locate the
related_topics list for "default_topic_replication" in
docs-data/property-overrides.json and remove the redundant entry (keep a single
canonical xref link, e.g., either the backticked form or the plain form) so the
array contains unique links only.
- Line 1690: The description uses a fragile inline anchor
`<<redpandastorage-mode, \`redpanda.storage.mode\`>>`; replace it with a full
Antora cross-reference to the property topic anchor (e.g. use the Antora xref
format pointing to the `redpanda.storage.mode` property topic) so the link
resolves reliably; locate the JSON property's "description" value and update the
inline reference to the canonical Antora resource ID for `redpanda.storage.mode`
instead of `redpandastorage-mode`.
- Around line 777-779: The description for default_redpanda_storage_mode
incorrectly xrefs cluster properties
cloud_storage_enable_remote_read/cloud_storage_enable_remote_write while saying
the fallback is to topic properties redpanda.remote.read and
redpanda.remote.write; update the xref targets to the correct Antora resource
IDs for the topic properties (redpanda.remote.read and redpanda.remote.write)
and ensure the xref uses full Antora IDs (e.g., xref:...
,`redpanda.remote.read`) so the link text and linked resource accurately reflect
the behavior referenced in the description.
In `@docs-data/redpanda-property-changes-v26.1.1-to-v26.1.1-rc5.json`:
- Around line 3-4: Swap the version values so the comparison direction is
correct: set "oldVersion" to the earlier release and "newVersion" to the later
one (i.e., make the prerelease/rc the old version and the final release the new
version or vice versa depending on intended direction). Edit the JSON keys
"oldVersion" and "newVersion" in the document (the entries named oldVersion and
newVersion) so the semantic order reflects chronological/release progression and
not the current reversed state.
In `@modules/develop/pages/manage-topics/config-topics.adoc`:
- Around line 199-200: The example command for topic config uses an invalid dash
character in "rpk topic alter-config [TOPICS…] —-set cleanup.policy=compact";
update the example so the flag uses the correct ASCII double hyphen "--set"
(i.e., change "—-set" to "--set") in the "rpk topic alter-config" example to
ensure the CLI accepts the flag.
- Line 55: Replace the overly strict phrase "NOTE: The replication factor must
be an odd number." with wording that states odd replication factors are
recommended but not required (e.g., "NOTE: An odd replication factor is
recommended") in the same paragraph that mentions the recommended value of 3 and
the cluster-level minimum_topic_replications property; update the sentence
around the existing text "Redpanda Data recommends a replication factor of 3" to
flow with the new recommendation wording and ensure the cluster property
reference (`minimum_topic_replications`) remains intact.
In `@modules/develop/pages/produce-data/leader-pinning.adoc`:
- Around line 181-182: Remove or replace the TODO/commented placeholder in the
“Suggested reading.” section: either delete the two commented lines starting
with "// TODO: Add link to Cloud Topics" and the following commented link, or
replace them with a proper xref to the Cloud Topics page (e.g., add the AsciiDoc
link text xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics]) so the
Suggested reading section contains a valid, non-commented reference instead of a
TODO.
In `@modules/manage/examples/kubernetes/group-crds.feature`:
- Around line 6-35: Add verification and cleanup steps to the "Manage group
ACLs" scenario so the test asserts the Group CR was created and removes it
afterward: after applying the manifest add a verification step such as checking
the Group named "engineering" is synced (e.g., a step similar to user "X" is
successfully synced) and then add a cleanup step to delete the CRD Group
"engineering" (e.g., a step like I delete the CRD group "engineering"); ensure
the step texts match existing step definitions or add corresponding step
definitions for Group if needed.
In `@modules/manage/examples/kubernetes/user-crds.feature`:
- Around line 110-112: Update the cluster reference in the feature manifest so
it matches the scenario tag and Background; change the value of clusterRef.name
from "redpanda" to "sasl" for the current occurrence and for the two other
occurrences of clusterRef.name in this feature (the ones corresponding to the
new `@cluster`:sasl scenarios). Locate and edit the clusterRef.name entries in the
user-crds.feature scenarios and replace "redpanda" with "sasl" so all scenario
cluster references are consistent.
In `@modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc`:
- Around line 140-142: The example line iceberg_default_catalog_namespace
currently appears active with a placeholder value; either comment it out using
an AsciiDoc comment prefix (e.g., prefix the line with //) or mark it explicitly
as optional in-line (e.g., append " (optional — replace only if you want a
custom namespace)") so users won’t accidentally copy/paste a literal
"<custom-namespace>"; update the example surrounding text to refer to the
commented/optional property and keep the symbol
iceberg_default_catalog_namespace for locating the change.
In `@modules/manage/pages/security/fips-compliance.adoc`:
- Around line 159-160: Remove or resolve the inline TODO about OpenSSL/FIPS
before release: either replace the TODO in the FIPS paragraph with the confirmed
OpenSSL version and FIPS 140-3 certificate number (from ENG-307) and update the
README-FIPS.md link text/URL accordingly, or delete the TODO and add a finalized
sentence stating the verified OpenSSL version and certificate number with the
updated link; ensure the comment "TODO: Confirm OpenSSL version and FIPS 140-3
certificate number with engineering (ENG-307)" is no longer present in the
published text.
In `@modules/manage/partials/gbac-dp.adoc`:
- Line 118: The Asciidoc uses relative API links like
link:/api/doc/cloud-controlplane/operation/operation-groupservice_creategroup[`POST
/v1/groups`] which break in Netlify previews; update that link (and the other
occurrences listed: lines referencing the same /api/... pattern at 175, 251,
280, 282, 295, 365, 375, 388, 390, 402, 412) to use the absolute docs URL format
(e.g. start with https://docs.redpanda.com/api/...) preserving the path and link
text, so replace each link:/api/... instance with its corresponding
https://docs.redpanda.com/api/... URL.
In `@modules/manage/partials/remote-read-replicas.adoc`:
- Line 443: Replace the broken AsciiDoc cross-reference token by using the
auto-generated anchor for the "Create a Remote Read Replica topic" heading:
change the reference string from <<Create a Remote Read Replica topic,topic
creation command>> to <<create-a-remote-read-replica-topic,topic creation
command>> so the link resolves correctly to the auto-generated anchor
create-a-remote-read-replica-topic in the document.
In `@modules/reference/pages/properties/topic-properties.adoc`:
- Around line 36-50: The block describing flush.bytes lacks the anchor/heading
that other intra-page refs (e.g., <<flushbytes>>) target; add a named anchor and
heading for this property by inserting a section header like `[[flushbytes]]`
followed by `=== flush.bytes` immediately before the existing description block
(or rename the existing header to match `flushbytes`) so all `<<flushbytes>>`
cross-references resolve; ensure the anchor id and visible heading text exactly
match the identifier used elsewhere.
In `@modules/reference/partials/properties/topic-property-mappings.adoc`:
- Around line 66-67: This table row was edited directly in the autogenerated
partial and must be reverted to be generated from the source inputs; remove the
manual row with <<redpandastoragemode,`redpanda.storage.mode`>> /
xref:...[`default_redpanda_storage_mode`] from the partial and instead add or
correct the corresponding generator input (the property entry for
redpanda.storage.mode and its default_redpanda_storage_mode metadata) so the
generator emits the row during the next build; ensure the generator input uses
the exact property key "redpanda.storage.mode" and the identifier
"default_redpanda_storage_mode".
In `@modules/shared/partials/tristate-behavior-change-25-3.adoc`:
- Line 3: The xref in modules/shared/partials/tristate-behavior-change-25-3.adoc
is pointing to a non-existent anchor (`#behavior-changes`) — update the target
reference string
xref:get-started:release-notes/redpanda.adoc#behavior-changes[Redpanda v26.1
behavior changes] by either removing the fragment
(xref:get-started:release-notes/redpanda.adoc[Redpanda v26.1 behavior changes])
or replacing `#behavior-changes` with the actual anchor present in
release-notes/redpanda.adoc (or add the corresponding anchor in that file), so
the cross-reference resolves.
---
Outside diff comments:
In `@modules/reference/partials/properties/topic-properties.adoc`:
- Around line 947-988: Update the broken AsciiDoc anchor reference for the
redpanda.storage.mode property: replace the incorrect inline anchor reference
`<<redpandastorage-mode, `redpanda.storage.mode`>>` (used in the Topic
properties section/`redpanda.cloud_topic.enabled` doc block) with the correct
auto-generated anchor `<<redpanda-storage-mode, `redpanda.storage.mode`>>` so it
matches the heading `=== redpanda.storage.mode`'s hyphenated anchor.
---
Nitpick comments:
In `@modules/deploy/pages/redpanda/manual/production/dev-deployment.adoc`:
- Line 11: The xref link uses explicit link text instead of letting AsciiDoc
pull the target title; update the link
xref:develop:manage-topics/config-topics.adoc#configure-write-caching[write
caching] to use empty brackets
xref:develop:manage-topics/config-topics.adoc#configure-write-caching[] so the
link text is sourced from the target page title (edit the sentence in
dev-deployment.adoc where that xref appears).
In `@modules/get-started/pages/quick-start.adoc`:
- Line 448: Replace the hard-coded xref text in
modules/get-started/pages/quick-start.adoc by changing the link
xref:develop:manage-topics/config-topics.adoc#choose-the-replication-factor[Choose
the replication factor] to use empty brackets
xref:develop:manage-topics/config-topics.adoc#choose-the-replication-factor[] so
the rendered link text is not hard-coded; update the single occurrence that
contains "choose-the-replication-factor" in the file.
In `@modules/get-started/pages/release-notes/redpanda.adoc`:
- Line 50: The xref to the Leader Pinning doc uses an explicit title; change
xref:develop:produce-data/leader-pinning.adoc[Leader Pinning] to use empty
brackets (xref:develop:produce-data/leader-pinning.adoc[]) so the title is
pulled automatically (same style as the other xref on line 13); update the
single occurrence in the sentence about ordered_racks to use the empty-bracket
xref.
- Line 13: Replace the explicit link text in the xref call so the target
document's title is pulled automatically; change the xref reference
xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] to use empty brackets
xref:develop:manage-topics/cloud-topics.adoc[] (i.e., update the xref on the
line containing xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] to
xref:develop:manage-topics/cloud-topics.adoc[]).
In `@modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc`:
- Line 223: Replace the hard-coded xref link text "*
xref:develop:manage-topics/config-topics.adoc[Manage Topics] - Create and manage
topics" with an empty-bracket xref so the target page title is used
automatically; update the string to use
"xref:develop:manage-topics/config-topics.adoc[]" and remove the manual "Manage
Topics - Create and manage topics" suffix so the linked page title renders
consistently.
In `@modules/manage/pages/kubernetes/k-schema-controller.adoc`:
- Line 281: Replace the hard-coded link text in the xref call for the Schema
Registry ACLs reference so the target title remains the source-of-truth: locate
the xref instance
`xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[Manage
Schema Registry ACLs (Operator)]` in k-schema-controller.adoc and change it to
use empty brackets (`...[]`) so it becomes
`xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[]`.
In `@modules/manage/partials/authentication.adoc`:
- Line 870: Replace the hard-coded AsciiDoc link
xref:manage:security/authorization/gbac.adoc[group-based access control (GBAC)]
with the preferred xref form xref:manage:security/authorization/gbac.adoc[] so
the link text is auto-synced to the destination title; update the TIP line that
mentions GBAC to use xref:manage:security/authorization/gbac.adoc[] and leave
the surrounding sentence and example (the `groups` claim) unchanged.
In `@modules/manage/partials/remote-read-replicas.adoc`:
- Line 473: Update the NOTE about endpoint usage to include concrete examples
showing how the bucket is applied for each URL style: add a clear virtual_host
example like "s3.us-east-1.amazonaws.com → my-bucket.s3.us-east-1.amazonaws.com"
and a path example like "s3.us-east-1.amazonaws.com →
s3.us-east-1.amazonaws.com/my-bucket", and ensure the examples appear next to
the existing mention of `endpoint`, `virtual_host`, and `path` URL styles in the
same paragraph so users can quickly verify their configuration.
- Around line 475-482: Add a short definition for "object storage target" before
the "Limits" header: state that a target represents a distinct object storage
configuration used by a remote cluster (combination of bucket, region, and
endpoint or just region+endpoint depending on cloud_storage_url_style). Then
keep the existing explanation showing how targets are counted, referencing the
config key `cloud_storage_url_style` and the two modes `virtual_host` and `path`
so readers understand why counting differs.
In `@modules/upgrade/pages/k-compatibility.adoc`:
- Line 22: Update the example to use the current 26.1 series instead of 25.3.1:
replace the sentence that currently reads "Redpanda Operator version 25.3.1
supports Redpanda core versions 26.1.x, 25.3.x, and 25.2.x" with a 26.1 example
such as "Redpanda Operator version 26.1.1 supports Redpanda core versions
27.1.x, 26.1.x, and 25.3.x" so the operator version and its listed supported
core versions align with the v26.1 documentation.
🪄 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: 5a63a704-23e8-4074-a74b-ee3910c5060c
📒 Files selected for processing (70)
antora.ymldocs-data/property-overrides.jsondocs-data/redpanda-property-changes-v25.3.1-to-v25.3.3.jsondocs-data/redpanda-property-changes-v25.3.10-to-v25.3.11.jsondocs-data/redpanda-property-changes-v25.3.7-to-v26.1.1-rc5.jsondocs-data/redpanda-property-changes-v26.1.1-to-v26.1.1-rc5.jsonmodules/ROOT/nav.adocmodules/console/pages/ui/edit-topic-configuration.adocmodules/deploy/pages/console/kubernetes/deploy.adocmodules/deploy/pages/redpanda/manual/production/dev-deployment.adocmodules/deploy/partials/high-availability.adocmodules/develop/pages/kafka-clients.adocmodules/develop/pages/manage-topics/cloud-topics.adocmodules/develop/pages/manage-topics/config-topics.adocmodules/develop/pages/manage-topics/index.adocmodules/develop/pages/produce-data/configure-producers.adocmodules/develop/pages/produce-data/leader-pinning.adocmodules/get-started/pages/quick-start.adocmodules/get-started/pages/release-notes/helm-charts.adocmodules/get-started/pages/release-notes/operator.adocmodules/get-started/pages/release-notes/redpanda.adocmodules/manage/examples/kubernetes/group-crds.featuremodules/manage/examples/kubernetes/role-crds.featuremodules/manage/examples/kubernetes/user-crds.featuremodules/manage/pages/audit-logging/audit-log-samples.adocmodules/manage/pages/cluster-maintenance/about-throughput-quotas.adocmodules/manage/pages/cluster-maintenance/compaction-settings.adocmodules/manage/pages/cluster-maintenance/continuous-data-balancing.adocmodules/manage/pages/cluster-maintenance/decommission-brokers.adocmodules/manage/pages/cluster-maintenance/disk-utilization.adocmodules/manage/pages/cluster-maintenance/manage-throughput.adocmodules/manage/pages/cluster-maintenance/topic-property-configuration.adocmodules/manage/pages/iceberg/about-iceberg-topics.adocmodules/manage/pages/iceberg/iceberg-topics-aws-glue.adocmodules/manage/pages/iceberg/iceberg-topics-databricks-unity.adocmodules/manage/pages/iceberg/query-iceberg-topics.adocmodules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adocmodules/manage/pages/iceberg/specify-iceberg-schema.adocmodules/manage/pages/iceberg/use-iceberg-catalogs.adocmodules/manage/pages/kubernetes/k-cloud-topics.adocmodules/manage/pages/kubernetes/k-decommission-brokers.adocmodules/manage/pages/kubernetes/k-schema-controller.adocmodules/manage/pages/kubernetes/security/authentication/k-schema-registry-acls.adocmodules/manage/pages/security/authorization/acl.adocmodules/manage/pages/security/authorization/gbac.adocmodules/manage/pages/security/authorization/index.adocmodules/manage/pages/security/fips-compliance.adocmodules/manage/partials/audit-logging.adocmodules/manage/partials/authentication.adocmodules/manage/partials/gbac-assign-group-role.adocmodules/manage/partials/gbac-create-group-acl.adocmodules/manage/partials/gbac-dp.adocmodules/manage/partials/remote-read-replicas.adocmodules/manage/partials/tiered-storage.adocmodules/reference/attachments/redpanda-properties-v26.1.1-rc5.jsonmodules/reference/pages/properties/cluster-properties.adocmodules/reference/pages/properties/topic-properties.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adocmodules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adocmodules/reference/pages/rpk/rpk-security/rpk-security-role-list.adocmodules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adocmodules/reference/partials/deprecated/deprecated-properties.adocmodules/reference/partials/properties/broker-properties.adocmodules/reference/partials/properties/cluster-properties.adocmodules/reference/partials/properties/object-storage-properties.adocmodules/reference/partials/properties/topic-properties.adocmodules/reference/partials/properties/topic-property-mappings.adocmodules/shared/partials/tristate-behavior-change-25-3.adocmodules/upgrade/pages/k-compatibility.adocmodules/upgrade/partials/incompat-changes.adoc
💤 Files with no reviewable changes (2)
- docs-data/redpanda-property-changes-v25.3.10-to-v25.3.11.json
- docs-data/redpanda-property-changes-v25.3.1-to-v25.3.3.json
Comment on lines
+777
to
+779
| "default_redpanda_storage_mode": { | ||
| "description": "Set the default storage mode for new topics. This value applies to any topic created without an explicit <<redpandastoragemode,`redpanda.storage.mode`>> setting (that is, when the topic's `redpanda.storage.mode` is `unset`).\n\nAccepted values:\n\n* `unset`: Defer to the legacy <<cloud_storage_enable_remote_read,`redpanda.remote.read`>> and <<cloud_storage_enable_remote_write,`redpanda.remote.write`>> topic properties for Tiered Storage configuration.\n* `local`: Store data only on local disks, with no object storage involvement.\n* `tiered`: Store data on local disks and replicate it to object storage using xref:manage:tiered-storage.adoc[Tiered Storage]. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.\n* `cloud`: Store data primarily in object storage using xref:manage:tiered-storage.adoc#cloud-topics[cloud topics].", | ||
| "related_topics": [ |
Contributor
There was a problem hiding this comment.
Fix mismatched references in default_redpanda_storage_mode description.
The text says fallback is to topic properties (redpanda.remote.read / redpanda.remote.write), but the links currently reference different cluster properties (cloud_storage_enable_remote_*).
Suggested fix
-* `unset`: Defer to the legacy <<cloud_storage_enable_remote_read,`redpanda.remote.read`>> and <<cloud_storage_enable_remote_write,`redpanda.remote.write`>> topic properties for Tiered Storage configuration.
+* `unset`: Defer to the legacy xref:reference:properties/topic-properties.adoc#redpandaremoteread[`redpanda.remote.read`] and xref:reference:properties/topic-properties.adoc#redpandaremotewrite[`redpanda.remote.write`] topic properties for Tiered Storage configuration.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs-data/property-overrides.json` around lines 777 - 779, The description
for default_redpanda_storage_mode incorrectly xrefs cluster properties
cloud_storage_enable_remote_read/cloud_storage_enable_remote_write while saying
the fallback is to topic properties redpanda.remote.read and
redpanda.remote.write; update the xref targets to the correct Antora resource
IDs for the topic properties (redpanda.remote.read and redpanda.remote.write)
and ensure the xref uses full Antora IDs (e.g., xref:...
,`redpanda.remote.read`) so the link text and linked resource accurately reflect
the behavior referenced in the description.
| "category": "redpanda" | ||
| }, | ||
| "redpanda.cloud_topic.enabled": { | ||
| "description": "Enable Cloud Topic storage mode for this topic. When enabled, topic data is stored primarily in object storage with local storage used only as a write buffer.\n\nTIP: To configure storage modes with more flexibility, use <<redpandastorage-mode, `redpanda.storage.mode`>> which supports `local`, `tiered`, `cloud`, and `unset` modes.", |
Contributor
There was a problem hiding this comment.
Broken/fragile cross-reference to redpanda.storage.mode.
<<redpandastorage-mode, ...>> is likely not a valid anchor and can render as a broken link. Use a full Antora xref to the topic property anchor.
Suggested fix
-TIP: To configure storage modes with more flexibility, use <<redpandastorage-mode, `redpanda.storage.mode`>> which supports `local`, `tiered`, `cloud`, and `unset` modes.
+TIP: To configure storage modes with more flexibility, use xref:reference:properties/topic-properties.adoc#redpandastoragemode[`redpanda.storage.mode`] which supports `local`, `tiered`, `cloud`, and `unset` modes.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| "description": "Enable Cloud Topic storage mode for this topic. When enabled, topic data is stored primarily in object storage with local storage used only as a write buffer.\n\nTIP: To configure storage modes with more flexibility, use <<redpandastorage-mode, `redpanda.storage.mode`>> which supports `local`, `tiered`, `cloud`, and `unset` modes.", | |
| "description": "Enable Cloud Topic storage mode for this topic. When enabled, topic data is stored primarily in object storage with local storage used only as a write buffer.\n\nTIP: To configure storage modes with more flexibility, use xref:reference:properties/topic-properties.adoc#redpandastoragemode[`redpanda.storage.mode`] which supports `local`, `tiered`, `cloud`, and `unset` modes.", |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs-data/property-overrides.json` at line 1690, The description uses a
fragile inline anchor `<<redpandastorage-mode, \`redpanda.storage.mode\`>>`;
replace it with a full Antora cross-reference to the property topic anchor (e.g.
use the Antora xref format pointing to the `redpanda.storage.mode` property
topic) so the link resolves reliably; locate the JSON property's "description"
value and update the inline reference to the canonical Antora resource ID for
`redpanda.storage.mode` instead of `redpandastorage-mode`.
Comment on lines
1839
to
1843
| "xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`]", | ||
| "xref:develop:config-topics.adoc#choose-the-replication-factor[Choose the replication factor]", | ||
| "xref:develop:config-topics.adoc#change-the-replication-factor[Change the replication factor]", | ||
| "xref:develop:manage-topics/config-topics.adoc#choose-the-replication-factor[Choose the replication factor]", | ||
| "xref:develop:manage-topics/config-topics.adoc#change-the-replication-factor[Change the replication factor]", | ||
| "xref:reference:properties/cluster-properties.adoc#default_topic_replication[default_topic_replication]" | ||
| ], |
Contributor
There was a problem hiding this comment.
Remove duplicate related_topics entry.
default_topic_replication is listed twice in this related_topics array.
Suggested fix
"related_topics": [
"xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`]",
"xref:develop:manage-topics/config-topics.adoc#choose-the-replication-factor[Choose the replication factor]",
- "xref:develop:manage-topics/config-topics.adoc#change-the-replication-factor[Change the replication factor]",
- "xref:reference:properties/cluster-properties.adoc#default_topic_replication[default_topic_replication]"
+ "xref:develop:manage-topics/config-topics.adoc#change-the-replication-factor[Change the replication factor]"
],🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs-data/property-overrides.json` around lines 1839 - 1843, The
related_topics array for the property default_topic_replication contains a
duplicate link entry; locate the related_topics list for
"default_topic_replication" in docs-data/property-overrides.json and remove the
redundant entry (keep a single canonical xref link, e.g., either the backticked
form or the plain form) so the array contains unique links only.
Comment on lines
+3
to
+4
| "oldVersion": "v26.1.1", | ||
| "newVersion": "v26.1.1-rc5", |
Contributor
There was a problem hiding this comment.
Version comparison direction is reversed.
oldVersion is newer than newVersion (v26.1.1 vs v26.1.1-rc5), which makes the diff semantics backward and potentially misleading for release-change consumers.
Suggested fix
- "oldVersion": "v26.1.1",
- "newVersion": "v26.1.1-rc5",
+ "oldVersion": "v26.1.1-rc5",
+ "newVersion": "v26.1.1",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| "oldVersion": "v26.1.1", | |
| "newVersion": "v26.1.1-rc5", | |
| "oldVersion": "v26.1.1-rc5", | |
| "newVersion": "v26.1.1", |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs-data/redpanda-property-changes-v26.1.1-to-v26.1.1-rc5.json` around lines
3 - 4, Swap the version values so the comparison direction is correct: set
"oldVersion" to the earlier release and "newVersion" to the later one (i.e.,
make the prerelease/rc the old version and the final release the new version or
vice versa depending on intended direction). Edit the JSON keys "oldVersion" and
"newVersion" in the document (the entries named oldVersion and newVersion) so
the semantic order reflects chronological/release progression and not the
current reversed state.
| rpk topic create xyz -r 3 | ||
| ---- | ||
|
|
||
| NOTE: The replication factor must be an odd number. Redpanda Data recommends a replication factor of 3 for most use cases. Administrators may set a minimum required replication factor for any new topic in the cluster through the cluster-level xref:reference:cluster-properties.adoc#minimum_topic_replications[`minimum_topic_replications`] property. |
Contributor
There was a problem hiding this comment.
Replication factor is recommended to be odd, not required.
“Must be an odd number” is too strict and factually incorrect for Kafka-compatible replication settings.
Suggested fix
-NOTE: The replication factor must be an odd number. Redpanda Data recommends a replication factor of 3 for most use cases.
+NOTE: Redpanda Data recommends an odd replication factor (typically 3) for most use cases.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modules/develop/pages/manage-topics/config-topics.adoc` at line 55, Replace
the overly strict phrase "NOTE: The replication factor must be an odd number."
with wording that states odd replication factors are recommended but not
required (e.g., "NOTE: An odd replication factor is recommended") in the same
paragraph that mentions the recommended value of 3 and the cluster-level
minimum_topic_replications property; update the sentence around the existing
text "Redpanda Data recommends a replication factor of 3" to flow with the new
recommendation wording and ensure the cluster property reference
(`minimum_topic_replications`) remains intact.
| Starting in Redpanda v25.3, several topic properties support enhanced tristate behavior. Properties like `retention.ms`, `retention.bytes`, `segment.ms`, and others now distinguish between zero values (immediate eligibility for cleanup/compaction) and negative values (disable the feature entirely). Previously, zero and negative values were treated the same way. | ||
| ifndef::env-cloud[] | ||
| For the complete list of affected properties and detailed information, see xref:25.3@get-started:release-notes/redpanda.adoc#behavior-changes[Redpanda v25.3 behavior changes]. | ||
| For the complete list of affected properties and detailed information, see xref:get-started:release-notes/redpanda.adoc#behavior-changes[Redpanda v26.1 behavior changes]. |
Contributor
There was a problem hiding this comment.
Broken xref target (#behavior-changes).
The target page does not expose a behavior-changes anchor, so this link will break.
Suggested fix
-For the complete list of affected properties and detailed information, see xref:get-started:release-notes/redpanda.adoc#behavior-changes[Redpanda v26.1 behavior changes].
+For the complete list of affected properties and detailed information, see xref:get-started:release-notes/redpanda.adoc[Redpanda v26.1 release notes].🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modules/shared/partials/tristate-behavior-change-25-3.adoc` at line 3, The
xref in modules/shared/partials/tristate-behavior-change-25-3.adoc is pointing
to a non-existent anchor (`#behavior-changes`) — update the target reference
string xref:get-started:release-notes/redpanda.adoc#behavior-changes[Redpanda
v26.1 behavior changes] by either removing the fragment
(xref:get-started:release-notes/redpanda.adoc[Redpanda v26.1 behavior changes])
or replacing `#behavior-changes` with the actual anchor present in
release-notes/redpanda.adoc (or add the corresponding anchor in that file), so
the cross-reference resolves.
Feediver1
approved these changes
Mar 31, 2026
This was referenced Mar 31, 2026
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks