Clarify sr import mode producer behavior#1686
Conversation
Reword the mode summary so import mode does not read as "only registration works", and add a NOTE in the IMPORT mode section calling out that producers and consumers continue to operate against already-registered schemas. Recommend auto.register.schemas=false on Confluent serializers to avoid client-side auto-registration errors. Cross-link the new note from the 25.3 breaking-change CAUTION.
Lead with what the mode does and denies (4-bullet behavior list) instead of a procedural recipe, then group operations under explicit subheadings: Choose subject-level or global, Enable, Register with an explicit ID and version, and Return to read-write mode. The subheadings make the section navigable on a long page, and the explicit Return-to-read-write subsection closes the loop so readers know how to exit the mode.
✅ 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 updates the Schema Registry API documentation for the IMPORT mode section. The changes clarify the runtime behavior during Redpanda 25.3+ migrations, specifying that registration in import mode accepts only requests with explicit schema IDs and versions while bypassing compatibility checks. The documentation expands migration workflow guidance with notes on continuous migration, client-side instructions to disable auto-registration, clarification of global versus subject-level import mode selection, and a new subsection describing the process to return to read-write mode when migration completes. Sequence Diagram(s)This section is not applicable to this change, as the pull request contains documentation updates only without introducing new features or modifying control flow. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
modules/manage/pages/schema-reg/schema-reg-api.adoc (1)
1194-1194: Avoid hard-coded section link text to prevent drift.Consider using implicit section-title references (for example,
<<set-global-mode>>,<<set-mode-for-a-subject>>) so link labels stay synced if headings are renamed.Based on learnings: “AsciiDoc linking: prefer using xref links with empty brackets ... Avoid hard-coding link text ... applies to all .adoc files.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/pages/schema-reg/schema-reg-api.adoc` at line 1194, The AsciiDoc text currently uses hard-coded section link labels that can drift; update the two links that point to the Set global mode and Set mode for a subject sections to use implicit xref references (e.g., replace the explicit labeled forms with <<set-global-mode>> and <<set-mode-for-a-subject>>) so the link text is derived from the target section title and stays synced if headings are renamed; locate the occurrences referencing "Set global mode" and "Set mode for a subject" in this paragraph and swap them to the implicit anchor forms mentioned.
🤖 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/manage/pages/schema-reg/schema-reg-api.adoc`:
- Line 1194: The AsciiDoc text currently uses hard-coded section link labels
that can drift; update the two links that point to the Set global mode and Set
mode for a subject sections to use implicit xref references (e.g., replace the
explicit labeled forms with <<set-global-mode>> and <<set-mode-for-a-subject>>)
so the link text is derived from the target section title and stays synced if
headings are renamed; locate the occurrences referencing "Set global mode" and
"Set mode for a subject" in this paragraph and swap them to the implicit anchor
forms mentioned.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 329d458a-8f96-4ccf-b6c2-bc5cde2bf914
📒 Files selected for processing (1)
modules/manage/pages/schema-reg/schema-reg-api.adoc
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: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
|
They all make sense, thank you, @Feediver1! I've applied them now. |
2 participants
Description
Clarify some key points about how import mode works in the schema registry (see the diff for details) based on customer feedback.
Not related to a Jira ticket, but prompted by this slack discussion: https://redpandadata.slack.com/archives/C02FSLH3ZS9/p1777040640447529
Page previews
Checks