Skip to content

docs: retire BYOA glossary term, add self-managed agent and MCP server terms#1759

Merged
micheleRP merged 1 commit into
sharedfrom
glossary-retire-byoa
Jun 23, 2026
Merged

docs: retire BYOA glossary term, add self-managed agent and MCP server terms#1759
micheleRP merged 1 commit into
sharedfrom
glossary-retire-byoa

Conversation

@micheleRP

Copy link
Copy Markdown
Contributor

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.

  • Remove the BYOA term (modules/terms/partials/byoa.adoc).
  • Add self-managed agent term. 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").
  • Add self-managed MCP server term, paired with the existing managed MCP server concept.
  • Update the declarative agent term 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 shared branch.

🤖 Generated with Claude Code

…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>
@micheleRP micheleRP requested a review from a team as a code owner June 22, 2026 23:01
@netlify

netlify Bot commented Jun 22, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit dad22bc
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a39bebffcd1f50008a40d48
😎 Deploy Preview https://deploy-preview-1759--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 Jun 22, 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: b9b61d50-8eac-4043-9254-709ecdde3f59

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 glossary-retire-byoa

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

@Feediver1 Feediver1 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.

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 bare BYOA) 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 agent term resolves (and was updated in this PR).

Suggestions

  1. self-managed-mcp-server.adoc — Asymmetric pairing. The definition contrasts against "a managed MCP server," but there is no managed MCP server glossary term (only the generic MCP server). The agent pair defines both declarative agent and self-managed agent. Consider adding a managed MCP server term for symmetry. Non-breaking: the reference is plain hover-text prose, not a glossterm: 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 agent dependency was updated within this PR.
  • adp-docs (not verified locally): Since the shared glossary auto-aggregates into adp-docs, confirm adp-docs main has no remaining glossterm:BYOA[] usages (i.e., #102 is 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 agent definition 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 agent term in the same PR, keeping the glossary internally consistent on merge.

🤖 Automated final-pass review via docs-team-standards pr-review.

@Feediver1 Feediver1 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, and Claude too

@micheleRP micheleRP merged commit 843407e into shared Jun 23, 2026
5 checks passed
@micheleRP micheleRP deleted the glossary-retire-byoa branch June 23, 2026 20:30
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