DOC-2254: Add Shadowing and Schema Registry context glossary terms#1777
Conversation
…t glossary terms New terms used by the Confluent Schema Registry migration docs (docs#1776). Overlaps DOC-1660 (Shadow Linking glossary terms, in progress) - flagged there to avoid duplication. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 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:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
@Feediver1 Suggest removing the "For more info" on each glossterm. We removed on all other entries earlier because of problems with links, especially with older versions. |
Glossary entries don't carry xref links: they were removed from all other entries earlier because the links break in older doc versions (the one remaining link, in admin-api.adoc, is a version-independent link:/api/... URL, not an xref). Hover-text definitions stand alone. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Feediver1
left a comment
There was a problem hiding this comment.
PR Review: Add Shadowing and Schema Registry context glossary terms (#1777)
Files reviewed: 3 glossary term partials (base: shared)
Overall assessment: Clean, accurate definitions that follow glossary conventions — including the no-links rule, now that Michele's feedback is applied in d9f9124. One useful discovery: the overlapping ticket DOC-1660 is effectively orphaned, which resolves the PR body's open question.
Michele's feedback — applied (d9f9124)
Removed the "For more information" xref line from all three partials. The rationale verified against the corpus: none of the other 133 glossary entries carries an xref: link — the single remaining link (admin-api.adoc) is a version-independent link:/api/doc/admin[] URL, which is exactly the versioned-xref breakage that motivated the rule.
Verification performed
- No duplicate term files (
shadow*/*context*sweep across all 134 partials — only these three plus the unrelatedcontext-window.adoc). - Consumer usage matches exactly: #1776/#1780 use
glossterm:shadow link[]andglossterm:shadow cluster[]with case-sensitive term-name matches. - The shadow-link definition's replication list matches the Shadowing overview, correctly omitting 26.2-only role sync since the
sharedbranch serves all versions. - Category and casing conventions match existing entries.
DOC-1660 overlap — resolved, needs Jira triage
The PR body defers to DOC-1660 (Shadow Linking glossary terms) if its definitions are further along. They aren't going anywhere: DOC-1660 is In Review but assigned to an inactive account (Angela Simms has left). Its definitions are engineering-internal (ShadowPanda, mirror partitions) and consistent with this PR's user-facing ones — no conflict. This PR should proceed; DOC-1660 needs reassignment or closing with these two terms counted as partial delivery.
Suggestion
No consumer currently uses glossterm:Schema Registry context[] (#1776 uses plain prose in the contexts section). The term is still worth having, but consider wiring #1776's first mention to it — that was the point of adding it.
Merge order
As the PR body states: before or with #1776, whose glossterm: macros resolve against these terms.
🤖 Generated with Claude Code
|
@micheleRP applied in d9f9124 — all three "For more information" lines removed. Confirmed the convention while at it: the other 133 glossary entries have no xref links (admin-api's version-independent |
Description
Adds three glossary terms used by the new Confluent Schema Registry migration page in #1776:
shadow link(Redpanda features)shadow cluster(Redpanda features)Schema Registry context(Redpanda features)Related to https://redpandadata.atlassian.net/browse/DOC-2254
Merge order: This PR should merge before or together with #1776, which uses
glossterm:shadow link[]andglossterm:shadow cluster[].🤖 Generated with Claude Code
Preview pages
This PR changes term partials only, so the rendered surface is the glossary page:
shadow link,shadow cluster,Schema Registry context)Note: this shared-branch preview assembles the 25.3 build; the
sharedbranch feeds every version, so the terms will appear in all versions' glossaries once merged.