Skip to content

Add ADP-specific glossary terms for GA#1691

Open
micheleRP wants to merge 17 commits into
sharedfrom
adp-glossary-terms
Open

Add ADP-specific glossary terms for GA#1691
micheleRP wants to merge 17 commits into
sharedfrom
adp-glossary-terms

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

Summary

Adds 10 new term partials to the canonical Redpanda glossary so the Agentic Data Plane (ADP) docs render glossterm: tooltips correctly at GA on 2026-06-15.

Closes the §3A R1 commitment in the ADP Docs Plan.

What's added

Term Source of truth
tool mcp_server.proto MCPTool
resource MCP spec via mcp_server.proto
declarative agent agent.proto Agent.managed.AgentManagedConfiguration
BYOA (bring your own agent) agent.proto Agent.self_managed
OAuth Provider oauth_provider.proto
OAuth Client oauth_client.proto (RFC 005)
OAuth Connection oauth_connection.proto
Token Vault token_vault_admin.proto
spending event spending_event.proto
Governance Dashboard Governance V0 PRD + RFC 006

All entries use the existing Agentic Data Plane category. Hover text was drafted against the cited proto comments; lowercase concept terms (tool, resource, declarative agent, spending event) and proper-cased product nouns (OAuth Provider, Token Vault, Governance Dashboard) follow established glossary conventions.

Why these specifically

  • tool / resource are already used as glossterm:tool[] / glossterm:resource[] across adp-docs MCP pages (mcp/test-tools.adoc, mcp/create-server.adoc, mcp/managed/managed-catalog.adoc, mcp/overview.adoc) but currently resolve to nothing. Bug fix.
  • The other 8 are ADP GA terms with no entry yet. Without them, OAuth/Token Vault/Spending Event concepts ship at GA without definitions.

Deliberately deferred

  • agent network — defer until Governance Dashboard V1 lands (post-GA).
  • virtual provider / virtual model — hold until the AI Gateway routing redesign settles in protos under adp/v1alpha1/.
  • guardrail — hold until the proto pivot (e0a1ba0cee / 7eff2ecbbf) is reflected in aigw/v1alpha1/.
  • ACU, BYOM, Capacity-Based Hybrid — strategy/billing terms; not in proto and not surfaced in customer-facing UI/CLI at GA.

Test plan

  • After merge, https://redpanda-agentic-data-plane.netlify.app/redpanda-adp/ resolves the new tooltips on existing glossterm:tool[] and glossterm:resource[] usages.
  • No build warnings on the canonical glossary index at https://docs.redpanda.com/current/reference/glossary/.
  • Companion adp-docs PR (replacing the glossary stub with an index page) opens against redpanda-data/adp-docs main after this PR lands.

🤖 Generated with Claude Code

Add 10 new term partials to support ADP docs at GA (2026-06-15):

- tool, resource: bug fix for existing glossterm: usage in adp-docs
  that currently renders as flat text (distinct from tool-invocation
  and resource-group)
- declarative-agent, byoa: agent runtime variants per agent.proto
- oauth-provider, oauth-client, oauth-connection, token-vault:
  OAuth resource model per the v1alpha1 proto suite (RFC 005)
- spending-event: per-LLM-request cost record per spending_event.proto
- governance-dashboard: V0 dashboard per the Governance V0 PRD + RFC 006

ADP Docs Plan §3A R1.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP requested a review from a team as a code owner May 6, 2026 16:20
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

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: fa61b169-a6fb-45f5-a5ba-e345e5e71a04

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 adp-glossary-terms

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

@netlify
Copy link
Copy Markdown

netlify Bot commented May 6, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 390c1e6
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a20b0518be51b0008f48363
😎 Deploy Preview https://deploy-preview-1691--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.

Comment thread modules/terms/partials/declarative-agent.adoc Outdated
Comment thread modules/terms/partials/governance-dashboard.adoc Outdated
Comment thread modules/terms/partials/oauth-client.adoc Outdated
Comment thread modules/terms/partials/oauth-client.adoc Outdated
Comment thread modules/terms/partials/spending-event.adoc Outdated
Comment thread modules/terms/partials/governance-dashboard.adoc Outdated
Comment thread modules/terms/partials/governance-dashboard.adoc Outdated
Comment thread modules/terms/partials/governance-dashboard.adoc Outdated
Comment thread modules/terms/partials/governance-dashboard.adoc Outdated
Comment thread modules/terms/partials/oauth-client.adoc Outdated
Comment thread modules/terms/partials/oauth-connection.adoc Outdated
Comment thread modules/terms/partials/oauth-provider.adoc Outdated
Comment thread modules/terms/partials/token-vault.adoc Outdated
micheleRP and others added 2 commits May 6, 2026 16:30
Lead each definition with the directional framing so tooltips reinforce
that OAuth providers govern outbound authentication (ADP -> upstream)
and OAuth clients govern inbound authentication (external app -> ADP).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Feediver1
Copy link
Copy Markdown
Contributor

Glossterm validation for PR #1691

PR #1691 adds 10 ADP term partials to modules/terms/partials/ on the shared branch. Checked final state
on the PR branch against shared-branch conventions and existing entries.

Verdict

All 10 partials are structurally valid and follow the glossterm conventions. No filename collisions, no
:term-name: collisions, all use the existing Agentic Data Plane category, all carry the required
4-line structure (=== heading + :term-name: + :hover-text: + :category:). Heading and :term-name: match
exactly (case-sensitive) on every file.

There's one keying inconsistency worth flagging plus one rebase-needed observation.

Verified structure (all 10 files)

┌───────────────────────────┬──────────────────────┬───────────────┬────────────┬────────────────┐
│ File │ :term-name: │ Category │ Heading │ Status │
│ │ │ │ match │ │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ byoa.adoc │ BYOA (bring your own │ Agentic Data │ ✓ │ ⚠️ keying — │
│ │ agent) │ Plane │ │ see below │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ declarative-agent.adoc │ declarative agent │ Agentic Data │ ✓ │ ✓ │
│ │ │ Plane │ │ │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ governance-dashboard.adoc │ governance dashboard │ Agentic Data │ ✓ │ ✓ │
│ │ │ Plane │ │ │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ oauth-client.adoc │ OAuth client │ Agentic Data │ ✓ │ ✓ │
│ │ │ Plane │ │ │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ oauth-connection.adoc │ OAuth connection │ Agentic Data │ ✓ │ ✓ │
│ │ │ Plane │ │ │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ oauth-provider.adoc │ OAuth provider │ Agentic Data │ ✓ │ ✓ │
│ │ │ Plane │ │ │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ resource.adoc │ resource │ Agentic Data │ ✓ │ ✓ (minor prose │
│ │ │ Plane │ │ nit) │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ spending-event.adoc │ spending event │ Agentic Data │ ✓ │ ✓ │
│ │ │ Plane │ │ │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ token-vault.adoc │ token vault │ Agentic Data │ ✓ │ ✓ │
│ │ │ Plane │ │ │
├───────────────────────────┼──────────────────────┼───────────────┼────────────┼────────────────┤
│ tool.adoc │ tool │ Agentic Data │ ✓ │ ✓ │
│ │ │ Plane │ │ │
└───────────────────────────┴──────────────────────┴───────────────┴────────────┴────────────────┘

Issue 1: byoa.adoc keying inconsistent with MCP/BYOC pattern

:term-name: BYOA (bring your own agent) means anyone writing glossterm:BYOA[] in adp-docs will get a
no-match. The full canonical form is what they'd need to type, or glossterm:BYOA (bring your own
agent)[,BYOA] to render as just "BYOA."

Comparing to the precedents already on shared:

=== Model Context Protocol (MCP) ← heading carries expansion
:term-name: MCP ← key is the acronym only
→ glossterm:MCP[] works

=== BYOC ← heading and key both just the acronym
:term-name: BYOC ← expansion lives in hover-text
→ glossterm:BYOC[] works

=== Agent2Agent (A2A) protocol ← heading AND key carry expansion
:term-name: Agent2Agent (A2A) protocol ← prose must use full key
→ glossterm:Agent2Agent (A2A) protocol[,A2A]

The new BYOA follows the Agent2Agent pattern, which is the verbose one. Its sibling BYOC is right there
with a much cleaner key. Recommend matching MCP/BYOC:

=== BYOA (bring your own agent)
:term-name: BYOA
:hover-text: An agent built and run by you...
:category: Agentic Data Plane

That keeps the expansion visible on the glossary index page while letting authors write
glossterm:BYOA[] directly. Up to @micheleRP, but worth aligning before this lands as the canonical pattern
other ADP acronyms will inherit.

Issue 2: PR branch is behind shared by 8 unrelated entries

shared has gained 8 new term partials since this PR branched on 2026-05-06 (from PR #1710 — Iceberg +
Redpanda SQL terms): iceberg-catalog, iceberg-mode, iceberg-topic, iceberg-translation, oxla,
redpanda-catalog, redpanda-sql, wire-format. None of them collide with this PR's 10 additions — a
rebase or merge will be clean.

Suggestion: cross-term confusion potential for tool and resource

Neither is a hard collision (different :term-name: keys, so they coexist), but worth being aware of:

  • tool (new, ADP) vs MCP tool (existing, Redpanda Connect) — describe similar concepts from different
    angles. The new one is generic-MCP; the existing one is Connect-implementation-specific. Authors
    picking between glossterm:tool[] and glossterm:MCP tool[] need to know which context applies. Probably
    fine, since MCP tool is in Redpanda Connect category and ADP-docs authors will naturally reach for
    glossterm:tool[].
  • resource (new, ADP) vs resource group (existing, Redpanda Cloud) — different concepts entirely; no
    functional confusion.
  • tool (new) vs tool invocation (existing, ADP) — complementary; the new term defines the thing being
    invoked.

Minor prose nit

resource.adoc hover-text: "Read-only data exposed by an MCP server that an agent can fetch by URI." The
antecedent of "that" is slightly ambiguous (MCP server or data?). Cleaner: "Read-only data exposed by
an MCP server, fetchable by an agent through a URI." Optional — readers will parse the current form
correctly in context.

What works well

  • Consistent 4-line structure across all 10 partials — no extended definitions, no extra attributes, no
    formatting drift.
  • Sentence-case lowercase keys for concept terms (tool, resource, declarative agent, spending event,
    token vault, governance dashboard) — matches the established lowercase-concept-term pattern (broker,
    partition, connector, consumer, etc.).
  • Proper-noun preservation in OAuth roles — OAuth client/connection/provider correctly preserves the
    "OAuth" capitalization while lowercasing the role noun, matching how Iceberg catalog/Iceberg topic keep
    "Iceberg" but lowercase the role.
  • Final-state OAuth definitions reframed around inbound vs outbound authentication (commit d37d304) —
    much sharper than the original "external tool" framing; readers immediately understand the directional
    distinction.
  • Category reuse — no new category introduced; lands in the already-populated Agentic Data Plane
    alongside its peer ADP terms.
  • spending event definition is precise — calls out exactly what's in the payload
    (input/output/cached/cache-write tokens + identifiers) and where cost is computed (downstream), so it
    disambiguates with billing terminology.

Verification deferred

The PR claims glossterm:tool[] and glossterm:resource[] already exist as broken references on adp-docs
MCP pages. Couldn't verify directly from the docs repo (adp-docs is a separate repository). If those
usages are already in adp-docs prose, this PR will fix them on first build after merge; if they're
planned but not yet in adp-docs prose, no harm — the entries are still appropriately defined.

Recommended next steps

  1. Resolve the BYOA keying — either change :term-name: to just BYOA (recommended) or leave as-is if
    Agent2Agent-style verbose keys are the deliberate ADP convention.
  2. Local build check — after merge, hover-test on glossterm:tool[] and glossterm:resource[] in adp-docs
    to confirm tooltips render.

Worktrees cleaned up.

Change :term-name: from the full expansion to just the acronym so authors
can write glossterm:BYOA[] directly. The expansion stays visible on the
glossary index via the heading, matching the mcp.adoc and byoc.adoc precedent.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

2 participants