Skip to content

docs: replace "ADP" acronym with "Agentic Data Plane"#116

Merged
micheleRP merged 3 commits into
mainfrom
claude/remove-adp-acronym
Jul 1, 2026
Merged

docs: replace "ADP" acronym with "Agentic Data Plane"#116
micheleRP merged 3 commits into
mainfrom
claude/remove-adp-acronym

Conversation

@micheleRP

@micheleRP micheleRP commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

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 collapses Agentic Data Plane (ADP) first-use parentheticals to Agentic 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:

  1. Antora attributesenv-adp, page-adp (control build behavior)
  2. Page slugs / imageadp-overview.adoc, adp-quickstart.adoc, adp-architecture.png (renaming needs redirects; decided to keep URLs stable)
  3. Live product domainhttps://adp.redpanda.com in doc-detective goTo URLs
  4. RBAC permission stringsdataplane_adp_*
  5. Proto packages / API typesredpanda.api.adp.v1alpha1
  6. cloudv2 source pathsapps/adp-ui/..., proto/.../adp/...
  7. Example resource namesadp-production, redpanda-adp

Glossary follow-up (separate PR)

The shared glossary term rename is now open as a separate PR against the docs repo shared branch: 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 to glossterm:Agentic Data Plane[] and merge this PR, so there is no unresolved-glossterm window.

Verification

  • npm run build passes (exit 0, no errors).
  • Verified rendered output on the agentic-data-plane/home preview: sidebar, cards, headings, and CLI label all read "Agentic Data Plane".

🤖 Generated with Claude Code

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>
@micheleRP micheleRP requested a review from a team as a code owner June 30, 2026 21:38
@netlify

netlify Bot commented Jun 30, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-agentic-data-plane ready!

Name Link
🔨 Latest commit 28af0fd
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-agentic-data-plane/deploys/6a455cb43b848f0008f2b452
😎 Deploy Preview https://deploy-preview-116--redpanda-agentic-data-plane.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.

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 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: 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 .adoc is the 2 intentional glossterm: macros (see coordination note).
  • No over-replacement — every preserved identifier survived: env-adp, adp.redpanda.com (x6), dataplane_adp (x88), redpanda.api.adp (x14), the adp-overview/adp-quickstart slugs, example names (adp-production x24).
  • 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.com goTo URLs 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

  1. 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").
  2. Verbosity in dense spots — where "ADP" recurred in a paragraph (e.g. the cli/index.adoc intro), "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 shared branch). 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.

@Feediver1

Copy link
Copy Markdown
Contributor

Glossary coordination — merge sequence for the 2 remaining glossterm macros

Heads-up on the one loose end: this PR intentionally keeps the 2 glossterm:Agentic Data Plane (ADP)[] macros (cli/index.adoc:12, cli/gitops.adoc:12) so tooltips keep resolving. The paired glossary rename is redpanda-data/docs#1774 (renames the term Agentic Data Plane (ADP)Agentic Data Plane on the shared branch). Its body confirms these 2 macros are the only references to that term in any repo.

To avoid an unresolved-glossterm window, the order matters:

  1. Merge docs#1774 first (term renamed on shared).
  2. Then update the 2 macros hereglossterm:Agentic Data Plane[] (drop the (ADP)).
  3. Then merge this PR (docs: replace "ADP" acronym with "Agentic Data Plane" #116).

⚠️ Don't do step 2 early: if the macros are changed to glossterm:Agentic Data Plane[] before #1774 lands, this PR's preview breaks because the renamed term doesn't exist on shared yet. The current (ADP) macros are correct to hold until #1774 merges.

Options for the macro update (your call)

  • A — I make the 2-macro edit once #1774 merges. Ping me (or I can watch for it) and I'll push the (ADP)[] change to this branch so it's ready to merge. Guarantees no broken-glossterm window.
  • B — You handle it. After #1774 merges, update both macros to glossterm:Agentic Data Plane[] and merge.

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>
@micheleRP micheleRP merged commit e61c743 into main Jul 1, 2026
4 checks passed
@micheleRP micheleRP deleted the claude/remove-adp-acronym branch July 1, 2026 18:36
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.

3 participants