Skip to content

DOC-2254: Add Shadowing and Schema Registry context glossary terms#1777

Merged
Feediver1 merged 2 commits into
sharedfrom
DOC-2254-shadowing-glossary-terms
Jul 20, 2026
Merged

DOC-2254: Add Shadowing and Schema Registry context glossary terms#1777
Feediver1 merged 2 commits into
sharedfrom
DOC-2254-shadowing-glossary-terms

Conversation

@Feediver1

@Feediver1 Feediver1 commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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

Note: DOC-1660 (Add Shadow Linking and DR terms to Glossary) is In Progress and may cover the two shadow terms. If that work already has definitions drafted, prefer those and drop the duplicates here.

Merge order: This PR should merge before or together with #1776, which uses glossterm:shadow link[] and glossterm:shadow cluster[].

🤖 Generated with Claude Code

Preview pages

This PR changes term partials only, so the rendered surface is the glossary page:

  • Glossary (updated — all three new terms verified rendering in this preview: shadow link, shadow cluster, Schema Registry context)

Note: this shared-branch preview assembles the 25.3 build; the shared branch feeds every version, so the terms will appear in all versions' glossaries once merged.

…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>
@Feediver1
Feediver1 requested a review from a team as a code owner July 2, 2026 19:16
@netlify

netlify Bot commented Jul 2, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit d9f9124
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a5e41807c744000089b7320
😎 Deploy Preview https://deploy-preview-1777--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b34967f5-86e4-41bc-82ac-7d16f2e8078b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2254-shadowing-glossary-terms

Comment @coderabbitai help to get the list of available commands.

Comment thread modules/terms/partials/schema-registry-context.adoc
@micheleRP

Copy link
Copy Markdown
Contributor

@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 Feediver1 left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 unrelated context-window.adoc).
  • Consumer usage matches exactly: #1776/#1780 use glossterm:shadow link[] and glossterm: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 shared branch 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

@Feediver1

Copy link
Copy Markdown
Contributor Author

@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 link:/api/... is the lone, deliberate exception), so the hover-text definitions now stand alone as intended.

@micheleRP micheleRP left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@Feediver1
Feediver1 merged commit 5e595bb into shared Jul 20, 2026
5 checks passed
@Feediver1
Feediver1 deleted the DOC-2254-shadowing-glossary-terms branch July 20, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants