docs: align glossary and links with self-managed agent terminology#108
Conversation
Trims the glossary page to rely on the auto-generated terms aggregated from the docs shared branch (removing the hand-maintained, non-alphabetical term list), and retargets the retired byoa-register.adoc links to the self-managed agent guide. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Feediver1
left a comment
Feediver1
left a comment
There was a problem hiding this comment.
Final-pass review (docs-team-standards)
Overall: Clean, correct cleanup that completes the BYOA → self-managed agent migration. No critical issues — safe to merge once its dependency lands.
What this PR does
Follow-up to #102. Trims the glossary page to title + description so it relies on the auto-generated terms aggregated from the docs shared branch, and retargets the two remaining connect:byoa-register.adoc links to the new connect:self-managed-agents.adoc page (home pathway/CTA and the triggers overview NOTE).
Critical issues
None. Verified on the branch:
- Retarget target exists —
modules/connect/pages/self-managed-agents.adocis present, so both retargeted links resolve. - No stragglers — the only remaining
byoa-registermention is a:page-aliases:redirect on the new page (intentional; preserves old URLs). The old page is removed. - Zero
BYOAreferences anywhere in adp-docs — this also confirms removing theBYOAterm fromshared(docs#1759) is safe for adp-docs. - Glossary trim is safe — the page stays in
nav.adoc, themacros/glossaryextension is loaded in the playbook (auto-populates terms), and this matches the established minimal pattern (cloud-docs' glossary page is just= Glossary).
Suggestions
None blocking. Coordination note: this PR depends on docs#1759. Merging before it won't break the build (adp-docs has no glossterm: usages of the new terms), but the auto-generated glossary would briefly show the old BYOA term and omit self-managed agent / self-managed MCP server until #1759 lands. Merge #1759 first (or together) for term-content correctness.
Impact on other files
No impact detected. No other references to byoa-register.adoc; the page-alias handles inbound URLs; no What's New entry needed (link/glossary cleanup, not a new feature).
CodeRabbit
No CodeRabbit or human reviews posted.
What works well
:page-aliases:preserves the retiredbyoa-registerURL, so bookmarks and external links keep working.- Glossary trim removes genuine redundancy and aligns with the cloud-docs / docs minimal-glossary convention.
- Clean, complete retarget — no orphaned links to the removed page.
- Well-sequenced with docs#1759, and the dependency is called out explicitly.
🤖 Automated final-pass review via docs-team-standards pr-review.
2 participants
What
Follow-up to #102 (BYOA → self-managed agent guide), making the glossary and remaining links consistent.
modules/reference/pages/glossary.adoc): trim to just the title and description so it relies on the auto-generated terms aggregated from the docssharedbranch. Removes the hand-maintainedAgentic Data Plane termsbullet list, which was redundant with the auto-generated definitions, non-alphabetical, and not used by other components (cloud-docs and the docs ROOT glossary are already minimal).connect:byoa-register.adocreferences at the newconnect:self-managed-agents.adocpage and align the wording.modules/home/pages/index.adoc: pathway link + CTA ("Set up your agent").modules/connect/pages/triggers/overview.adoc: xref ("Set up a self-managed agent").Depends on
redpanda-data/docs#1759 (shared branch), which removes the
BYOAglossary term and adds theself-managed agentandself-managed MCP serverterms this page now pulls in.Preview pages
🤖 Generated with Claude Code