docs: retire BYOA glossary term, add self-managed agent and MCP server terms#1759
Conversation
…r terms Replaces the BYOA glossary term with self-managed agent (and adds a self-managed MCP server term) to match adp-docs PR #102, which retired the BYOA pages in favor of a self-managed agent guide. Also updates the declarative agent term to contrast against self-managed agent. 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
left a comment
There was a problem hiding this comment.
Final-pass review (docs-team-standards)
Overall: Surgical, well-scoped glossary change that's safe to merge. No critical issues — one symmetry suggestion and one cross-repo sequencing caveat.
What this PR does
Retires the BYOA glossary term and replaces it with self-managed agent and self-managed MCP server, and updates declarative agent to contrast against "self-managed agent" instead of "BYOA agent." Mirrors adp-docs#102.
Critical issues
None. Verified:
- BYOA removal is safe — zero
glossterm:BYOA[](or bareBYOA) usages in docs (main), cloud-docs, rp-connect-docs, docs-site, or docs-ui; no other term partial references BYOA after the declarative-agent fix. - Partial format correct — both new files match the existing convention exactly (
=== term/:term-name:/:hover-text:/:category: Agentic Data Plane, single trailing newline; filenames are correct kebab-case). - Aggregation needs no manual update — terms are auto-aggregated from the partials directory (no manual index), so add/delete of files is the complete mechanism.
- Cross-referenced
declarative agentterm resolves (and was updated in this PR).
Suggestions
self-managed-mcp-server.adoc— Asymmetric pairing. The definition contrasts against "a managed MCP server," but there is nomanaged MCP serverglossary term (only the genericMCP server). The agent pair defines bothdeclarative agentandself-managed agent. Consider adding amanaged MCP serverterm for symmetry. Non-breaking: the reference is plain hover-text prose, not aglossterm:link.
Impact on other files
- No changes needed in the docs repo — no nav entry, no manual glossary index, no usages to repoint; the
declarative agentdependency was updated within this PR. - adp-docs (not verified locally): Since the
sharedglossary auto-aggregates into adp-docs, confirm adp-docsmainhas no remainingglossterm:BYOA[]usages (i.e.,#102is merged) before/as this lands, so removing the term doesn't surface unknown-term warnings there. The PR's sequencing note already flags this direction.
CodeRabbit
No CodeRabbit review or inline comments posted, and no human reviews yet.
What works well
- Tightly scoped: four files, no collateral churn.
- The
self-managed agentdefinition is a genuine accuracy improvement over the old BYOA wording (AI Gateway is the agent's LLM/MCP endpoint; ADP attributes spend/tokens/latency/traces). - Verified-safe removal — no orphaned usages anywhere reachable.
- Updates the dependent
declarative agentterm in the same PR, keeping the glossary internally consistent on merge.
🤖 Automated final-pass review via docs-team-standards pr-review.
What
Updates the shared glossary to match adp-docs PR #102 (redpanda-data/adp-docs#102), which retired the BYOA / Bring Your Own Agent pages in favor of a self-managed agent guide.
BYOAterm (modules/terms/partials/byoa.adoc).self-managed agentterm. The definition corrects a factual point from the old BYOA wording: ADP does not host or run the agent, but the AI Gateway is its LLM and MCP endpoint (the old term incorrectly said ADP "does not host or proxy it").self-managed MCP serverterm, paired with the existing managed MCP server concept.declarative agentterm to contrast against "a self-managed agent" instead of "a BYOA agent".Why
The BYOA concept and pages were removed in adp-docs#102. No
glossterm:BYOA[]usages exist in any repo, so removing the term is safe.Notes
This should land before redpanda-data/adp-docs#TBD (the adp-docs side), since the adp-docs glossary page auto-aggregates these terms from the
sharedbranch.🤖 Generated with Claude Code