Add ADP-specific glossary terms for GA#1691
Conversation
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>
|
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 |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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>
|
Glossterm validation for PR #1691 PR #1691 adds 10 ADP term partials to modules/terms/partials/ on the shared branch. Checked final state Verdict All 10 partials are structurally valid and follow the glossterm conventions. No filename collisions, no There's one keying inconsistency worth flagging plus one rebase-needed observation. Verified structure (all 10 files) ┌───────────────────────────┬──────────────────────┬───────────────┬────────────┬────────────────┐ 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 Comparing to the precedents already on shared: === Model Context Protocol (MCP) ← heading carries expansion === BYOC ← heading and key both just the acronym === Agent2Agent (A2A) protocol ← heading AND key carry expansion The new BYOA follows the Agent2Agent pattern, which is the verbose one. Its sibling BYOC is right there === BYOA (bring your own agent) That keeps the expansion visible on the glossary index page while letting authors write 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 + 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:
Minor prose nit resource.adoc hover-text: "Read-only data exposed by an MCP server that an agent can fetch by URI." The What works well
Verification deferred The PR claims glossterm:tool[] and glossterm:resource[] already exist as broken references on adp-docs Recommended next steps
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>
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
toolmcp_server.protoMCPToolresourcemcp_server.protodeclarative agentagent.protoAgent.managed.AgentManagedConfigurationBYOA (bring your own agent)agent.protoAgent.self_managedOAuth Provideroauth_provider.protoOAuth Clientoauth_client.proto(RFC 005)OAuth Connectionoauth_connection.protoToken Vaulttoken_vault_admin.protospending eventspending_event.protoGovernance DashboardAll entries use the existing
Agentic Data Planecategory. 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/resourceare already used asglossterm:tool[]/glossterm:resource[]acrossadp-docsMCP pages (mcp/test-tools.adoc,mcp/create-server.adoc,mcp/managed/managed-catalog.adoc,mcp/overview.adoc) but currently resolve to nothing. Bug fix.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 underadp/v1alpha1/.guardrail— hold until the proto pivot (e0a1ba0cee/7eff2ecbbf) is reflected inaigw/v1alpha1/.ACU,BYOM,Capacity-Based Hybrid— strategy/billing terms; not in proto and not surfaced in customer-facing UI/CLI at GA.Test plan
https://redpanda-agentic-data-plane.netlify.app/redpanda-adp/resolves the new tooltips on existingglossterm:tool[]andglossterm:resource[]usages.redpanda-data/adp-docsmainafter this PR lands.🤖 Generated with Claude Code