DOC-1943 single source schema id validation#1565
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 You can disable this status message by setting the
📝 WalkthroughWalkthroughThis pull request updates documentation to introduce the Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
modules/manage/pages/schema-reg/schema-id-validation.adoc (1)
93-112:⚠️ Potential issue | 🔴 CriticalThese xref anchors don't exist in topic-properties.adoc—the links will break.
The schema properties are defined as level 3 headings in the properties partial file (e.g.,
=== redpanda.key.schema.id.validation), which auto-generates anchors with hyphens (e.g.,redpanda-key-schema-id-validation). However, all 8 xrefs reference anchor names without hyphens or separators (e.g.,#redpandakeyschemavalidation).The mismatch means the published documentation will contain broken links. Either add explicit anchors [[redpandakeyschemavalidation]] etc. to the properties or update the xrefs to use hyphenated anchor names matching the auto-generated ones.
🤖 Fix all issues with AI agents
In `@local-antora-playbook.yml`:
- Around line 22-23: The playbook currently pins the Antora remote repository
branch via the branches entry set to the feature branch name; change the
branches value to a stable branch (e.g., "main") and remove any committed
feature-branch override so local previews don’t break when the feature branch is
deleted; update the branches field in local-antora-playbook.yml (the entry with
url: https://github.com/redpanda-data/cloud-docs and branches:) to "main" and
ensure any feature-branch usage remains in your local configuration only.
🧹 Nitpick comments (2)
modules/reference/partials/properties/cluster-properties.adoc (2)
5071-5072: Use empty-bracket xref to avoid hard‑coded link text.Prefer
xref:manage:schema-reg/schema-id-validation.adoc[]so the title is sourced from the target page.As per coding guidelines: “prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically.”
5019-5021: Consider a CAUTION block for consistent rendering.Inline
CAUTION:works, but a formal block renders more consistently with other notes.Proposed tweak
-CAUTION: This property could cause decompression across topics and increase CPU load. +CAUTION: This property could cause decompression across topics and increase CPU load.
|
|
||
| Controls whether Redpanda validates schema IDs in records and which topic properties are enforced. | ||
|
|
||
| CAUTION: This property could cause decompression across topics and increase CPU load. |
There was a problem hiding this comment.
@micheleRP "NOTE: enabling this property will trigger decompression of message batches for topics on which validation is configured, leading to a modest increase in CPU load. We recommend monitoring CPU utilization after topics are configured"
@micheleRP note the TOPIC configurations are probably elsewhere in the ID validation docs(confluent.<key/value>.schema.validation)
There was a problem hiding this comment.
@mattschumpert I conditionalized out these topic properties for Cloud, since we don't document them in Cloud docs (see here). Please confirm that this is correct!
4 participants
Description
NOTE: Single sourcing for this in
cloud-docsin redpanda-data/cloud-docs#495This pull request updates doc for schema ID validation to support both cloud and SM environments.
// tag::redpanda-cloud[]and// end::redpanda-cloud[]) around the cloud-specific documentation for theenable_schema_id_validationproperty incluster-properties.adoc. [1] [2]enable_schema_id_validationproperty documentation, warning that enabling this property may cause decompression across topics and increase CPU load.redpanda.*andconfluent.*topic properties inschema-id-validation.adocto use conditional AsciiDoc macros (ifndef::env-cloud[]andifdef::env-cloud[]), ensuring correct property linking for cloud and non-cloud environments. [1] [2]Resolves https://redpandadata.atlassian.net/browse/DOC-1943
Review deadline:
Page previews
What's New in Redpanda Cloud
Schema ID Validation (in Cloud)
enable_schema_id_validation (in Cloud)
enable_schema_id_validation (in SM)
Checks