docs: replace "ADP" acronym with "Agentic Data Plane"#116
Conversation
The "ADP" acronym is trademarked by another company, so it must not appear in our docs. Replace all 410 prose occurrences of the acronym with "Agentic Data Plane" across pages, partials, nav, and the doc-detective test descriptions, and collapse "Agentic Data Plane (ADP)" first-use parentheticals. Left untouched (literal identifiers, not the brand acronym): RBAC permission strings (dataplane_adp_*), proto packages/API types (redpanda.api.adp.v1alpha1), cloudv2 source paths, Antora attributes (env-adp/page-adp), page slugs, the adp.redpanda.com domain, and example resource names (adp-production). These are tracked for team review. The two glossterm:Agentic Data Plane (ADP)[] macros are left intact so the tooltip keeps resolving; the shared glossary term will be renamed in a separate PR on the docs repo shared branch, then these macros updated. 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. |
Spelling out the acronym made the footer read "New to Agentic Data Plane? Read What is Agentic Data Plane?". Change the intro to "New here?" so the descriptive link text no longer repeats. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Feediver1
left a comment
There was a problem hiding this comment.
Final-pass review (docs-team-standards)
Overall: Clean, well-scoped mechanical rename driven by a trademark constraint. Scope and quality both verify well — no over-replacement, no missed prose, no broken anchors. No critical defects; one sequenced cross-PR dependency to track.
What this PR does
Replaces all 410 prose occurrences of the trademarked "ADP" acronym with "Agentic Data Plane" across 74 files (pages, partials, nav labels, doc-detective descriptions), collapsing Agentic Data Plane (ADP) parentheticals. Literal identifiers are deliberately left untouched. Compliance/terminology change, not a content change.
Critical issues
None. Verified across the whole diff:
- No missed prose — the only remaining "ADP" in
.adocis the 2 intentionalglossterm:macros (see coordination note). - No over-replacement — every preserved identifier survived:
env-adp,adp.redpanda.com(x6),dataplane_adp(x88),redpanda.api.adp(x14), theadp-overview/adp-quickstartslugs, example names (adp-productionx24). - No artifacts — zero empty
(), zero doubled "Agentic Data Plane Agentic Data Plane", zero redundant(Agentic Data Plane). - No broken anchors — headings changed text (e.g.
== ADP-namespaced permissions), but nothing xrefs the old#...adp...anchors. - doc-detective JSON valid, and its
adp.redpanda.comgoToURLs preserved.
Coordination (must track, not a defect here)
The 2 remaining glossterm:Agentic Data Plane (ADP)[] macros (cli/index.adoc:12, cli/gitops.adoc:12) render the link text "Agentic Data Plane (ADP)" — so "ADP" is still visible to readers there and in the glossary tooltip. Correctly deferred to the separate shared-glossary rename PR; the trademark goal isn't fully met until that PR merges and these two macros are updated. Land them in lockstep.
Suggestions
- Hyphenated-adjective awkwardness in a few headings:
Agentic Data Plane-hosted MCP servers,Agentic Data Plane-namespaced permissions. Optional rephrase to drop the hyphen ("MCP servers hosted in Agentic Data Plane", "permissions namespaced under Agentic Data Plane"). - Verbosity in dense spots — where "ADP" recurred in a paragraph (e.g. the
cli/index.adocintro), "Agentic Data Plane" now repeats 3-4 times. Unavoidable given the ban, but occasional rephrasing ("the platform", "the CLI") where the referent is clear reads more smoothly. Low priority.
Impact on other files
- Cross-repo sweep (follow-up): "ADP" prose almost certainly also exists in cloud-docs and docs (and the shared glossary term lives on the docs
sharedbranch). This PR covers only adp-docs; confirm the org-wide cleanup tracks cloud-docs/docs prose too (the glossary PR handles the shared term). - Deliberately-untouched identifiers each need a product/eng decision per the PR body — well documented, correctly out of scope.
- No What's New entry or nav-structure change needed.
CodeRabbit
No CodeRabbit or human reviews posted yet.
What works well
- Disciplined scoping — the hard part of a mass rename is not clobbering literal identifiers, and this nails it (88 RBAC strings + 14 proto packages + slugs + domain all intact).
- Excellent "deliberately left untouched" documentation in the PR body — makes the boundary auditable and routes product/eng decisions to the right owners.
- Sequenced glossary follow-up (keeping glossterm macros intact so tooltips resolve until the shared term is renamed) is the correct ordering.
- Clean heading expansions, valid JSON, no anchor breakage.
🤖 Automated final-pass review via docs-team-standards pr-review.
Glossary coordination — merge sequence for the 2 remaining glossterm macrosHeads-up on the one loose end: this PR intentionally keeps the 2 To avoid an unresolved-glossterm window, the order matters:
Options for the macro update (your call)
Either way works — flagging so the sequencing is visible. Once done, the only user-visible "ADP" in the Agentic Data Plane docs is gone. (Also open, for context: docs-team-standards#2861 — the rule prohibiting the "ADP" acronym.) |
…onym Resolve conflicts in gateway overview and configure-provider Limitations sections: keep the release-notes xref from main, use the full name 'Agentic Data Plane' in the link text. Also spell out 'ADP' in the merged release-notes page prose. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Preview pages
What
The ADP acronym is trademarked by another company, so it must not appear in our docs. This replaces all 410 prose occurrences of the acronym with Agentic Data Plane across pages, partials,
nav.adoc, and the doc-detective test descriptions, and collapsesAgentic Data Plane (ADP)first-use parentheticals toAgentic Data Plane.74 files changed.
Deliberately left untouched (literal identifiers, not the brand acronym)
These are factual references to real code/APIs/paths, so changing them in docs alone would be wrong. Each needs a product/engineering decision:
env-adp,page-adp(control build behavior)adp-overview.adoc,adp-quickstart.adoc,adp-architecture.png(renaming needs redirects; decided to keep URLs stable)https://adp.redpanda.comin doc-detectivegoToURLsdataplane_adp_*redpanda.api.adp.v1alpha1apps/adp-ui/...,proto/.../adp/...adp-production,redpanda-adpGlossary follow-up (separate PR)
The shared glossary term rename is now open as a separate PR against the
docsreposharedbranch: redpanda-data/docs#1774.The two
glossterm:Agentic Data Plane (ADP)[]macros (cli/index.adoc,cli/gitops.adoc) are left intact in this PR so the tooltip keeps resolving against the current term. Merge order: land docs#1774 first, then update those two macros toglossterm:Agentic Data Plane[]and merge this PR, so there is no unresolved-glossterm window.Verification
npm run buildpasses (exit 0, no errors).agentic-data-plane/homepreview: sidebar, cards, headings, and CLI label all read "Agentic Data Plane".🤖 Generated with Claude Code