Skip to content

Add ADP-specific glossary terms for GA#1691

Open
micheleRP wants to merge 14 commits intosharedfrom
adp-glossary-terms
Open

Add ADP-specific glossary terms for GA#1691
micheleRP wants to merge 14 commits intosharedfrom
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: ed240028-cd2b-45bf-828e-d9a451d60def

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 403f94a
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69fbc0f6abe72a0008e0d251
😎 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
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.

1 participant