Skip to content

Sync ADP docs with eng changes from week of 2026-05-04#15

Merged
micheleRP merged 1 commit into
mainfrom
adp-may8-eng-sync
May 8, 2026
Merged

Sync ADP docs with eng changes from week of 2026-05-04#15
micheleRP merged 1 commit into
mainfrom
adp-may8-eng-sync

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 8, 2026

Summary

Catch-up sweep against cloudv2 changes that landed between 2026-05-04 and 2026-05-08, plus drafts for two empty BYOA stubs and a docs-team-standards style pass on all new writing.

Eng evidence

  • cloudv2 #26183 (2026-05-07) [AI-953] feat: adds governance v0 (without governator) — first governance UI release
  • cloudv2 #26200 (2026-05-07) per-model rate-card override editor + catalog default display
  • cloudv2 #26206 (2026-05-08) governance tabs respect provider/model/user filter scoping
  • cloudv2 #26208 (2026-05-08) SpendingService AIP-160 filter expressions; server-derived total_tokens
  • cloudv2 #26209 (2026-05-08) Anthropic streaming cache_creation_input_tokens extraction fix
  • cloudv2 #26192 (2026-05-08) OAuth RevokeAllTokens RPC + rpk ai oauth-client revoke-tokens CLI + auto-revoke on lifecycle events
  • cloudv2 1f73266688 (2026-05-04) Metabase managed MCP + apps/aigw/docs/metabase-mcp.md
  • redpanda #30360 (2026-05-05) rpk ai help/version/<unknown> no longer prompts authentication
  • adp-ui apps/adp-ui/src/routes/governance/ is now the default top-level route when governance_tab_enabled is on

What's in this PR

Eng-sync content updates

  • modules/governance/pages/budgets.adoc — new Override per-model pricing section (input / output / cache-write at 5m / 1h / unknown TTL), AIP-160 filter callout on SpendingFilter, cache-write attribution note for streaming Anthropic responses
  • modules/governance/pages/dashboard/overview.adoc — new filter-scoping note (cards honor provider/model/user filters), cross-link to rate-card overrides
  • modules/mcp/pages/managed/metabase.adoc (new) — full Metabase deep-dive matching the Workday / Slack / Ramp pattern
  • modules/mcp/pages/managed/managed-catalog.adoc — Metabase row in the Database section
  • modules/ROOT/nav.adoc — Metabase nav entry
  • modules/integrations/pages/remote-mcp-clients.adoc — new Revoke all tokens subsection (UI + rpk ai oauth-client revoke-tokens CLI + auto-revoke on Client deletion)
  • modules/mcp/pages/oauth-providers.adoc — cross-link to Client revocation in the disambiguation note
  • modules/ai-gateway/pages/connect-agent.adoc — note that rpk ai help / version / <unknown> no longer prompts authentication
  • modules/observability/pages/transcripts.adoc — Anthropic cache-creation token note + cross-link to budgets rate-card section

BYOA drafts

  • modules/agents/pages/byoa-register.adoc — forward-looking how-to anchored on AgentRegistryService.CreateAgent and the well-known A2A /.well-known/agent-card.json contract. TODO comments mark each spot that needs the click-by-click flow once the BYOA arm of AgentCreate.agent_type lands and the UI route exists.
  • modules/observability/pages/byoa-telemetry.adoc — minimum required spans contract (service.name resource + gen_ai.conversation.id / gen_ai.operation.name / gen_ai.request.model / gen_ai.usage.input_tokens / gen_ai.usage.output_tokens), recommended enrichment, span hierarchy, validation walkthrough, troubleshooting.

Forward-looking-framing cleanup (across the repo)

  • Deleted agent-network.adoc and violations.adoc stubs (their content was 100% "Coming in a later release" placeholder framing); removed their nav entries.
  • Dropped the "What's coming in a later release" sections from dashboard/overview.adoc and budgets.adoc; moved roadmap items into // TODO: comments.
  • Removed every V0 / V1 / V2 / GA / general availability / 2026-06-15 reference from customer prose (kept inside // TODO: comments per project policy). Replaced "in a later release", "today's release", "current release", "currently planned", "available today" qualifiers throughout.
  • Marked four pre-existing forward-looking phrases with // TODO(review-before-publish): so a reviewer can grep the tag and decide each before merge:
    • ai-gateway/overview.adoc and ai-gateway/connect-agent.adoc — Cost & usage section "in development"
    • integrations/remote-mcp-clients.adoc — "Auth0 today, Zitadel in a future release" IdP migration mention
    • agents/overview.adoc — "Cross-agent calling between separate agents is not currently supported"
    • mcp/managed/managed-catalog.adoc — "every managed type currently registered"

docs-team-standards style pass on new writing

  • Em dashes in bullet definition lists converted to colons; mid-sentence em-dash asides converted to commas, parens, or sentence breaks.
  • Banned terms reworded: via (4 occurrences), and Understand learning-objective verb replaced with Identify.
  • Added intro text before tables, lists, and code blocks under every heading that previously had none (Metabase, BYOA register, BYOA telemetry, budgets Override section).
  • Removed directional language (below, in the previous section) in new prose; reworded as in this section or referenced by section name.
  • Removed quotation marks per the no-quotes rule.

Out of scope (deferred)

  • NetSuite managed MCP (cloudv2 #26186, 2026-05-08) — confirm the GA gate and staged-release status before adding to docs.
  • Service Accounts (OAuth M2M) — behind enable_internal_listener_and_service_accounts feature flag; not yet GA.
  • Guardrails — no proto changes since the last sweep; still mid-pivot per the Guardrails companion plan. Next move waits on team-ai's post-pivot answer.
  • §3A R1 glossary fill (docs#1691) — held until GA week.
  • Pre-existing em dashes in transcripts.adoc filter/column tables and other older sections — separate cleanup scope.

Open questions for the reviewer

Tagged in the source as // TODO: and // TODO(review-before-publish):grep -rn "TODO(review-before-publish)" modules/ lands on each:

  1. NetSuite MCP GA gate (out-of-scope today; confirm before next pass)
  2. Rate-card override exact UI route (verify against adp-production)
  3. Whether SpendingService overrides surface in GetSpendingBreakdown responses
  4. Whether OAuth Provider deletion (vs. Client) triggers token revocation
  5. BYOA agent_type proto variant name and registration UI surface
  6. BYOA standalone-ADP issuer / audience for inbound A2A authentication
  7. Whether service.name resource attribute should match a registered AgentRegistryService resource name
  8. Cost & usage "in development" framing on AI Gateway overview / connect-agent
  9. Auth0 → Zitadel IdP migration mention in remote-mcp-clients
  10. "Cross-agent calling not currently supported" framing in agents/overview
  11. "Currently registered" softener on managed-catalog

Test plan

  • npm run build reports zero adp-docs errors (the 6 errors in the build log originate from upstream redpanda-data/docs and redpanda-data/cloud-docs and are pre-existing).
  • npm run serve renders all four new / heavily-edited pages without broken xrefs:
    • governance/dashboard/overview/ — IMPORTANT box and roadmap section gone; new filter-scoping NOTE renders
    • governance/budgets/ — new Override section renders, override-per-model-pricing anchor resolves
    • mcp/managed/metabase/ — new deep-dive renders; nav entry visible; catalog row present
    • agents/byoa-register/ and observability/byoa-telemetry/ — BYOA drafts render with TODO markers
    • governance/dashboard/agent-network/ and violations/ — return 404 (deleted as expected)
  • grep -rn "TODO(review-before-publish)" modules/ returns 5 spots flagged for reviewer decision before merge.
  • Live walkthrough on adp-production to resolve TODO markers in budgets.adoc, transcripts.adoc, dashboard/overview.adoc against the V0 governance UI.
  • Confirm the BYOA registration page once eng defines AgentCreate.agent_type BYOA variant and the UI route.

🤖 Generated with Claude Code

Eng-driven updates to match what shipped in cloudv2 between 2026-05-04
and 2026-05-08:

- Document the new per-model rate-card override editor on the budgets
  page (cloudv2 #26200) and note AIP-160 filter expressions on
  SpendingService (cloudv2 #26208) plus correct cache-write token
  attribution on Anthropic streaming (cloudv2 #26209).
- Add a Metabase managed MCP deep-dive (cloudv2 1f73266688) with a
  catalog row and nav entry.
- Add a Revoke all tokens section on the Remote MCP Clients page
  covering the new RevokeAllTokens RPC, the rpk ai oauth-client
  revoke-tokens CLI, and auto-revocation on Client deletion
  (cloudv2 #26192).
- Cross-link OAuth Client revocation from the OAuth Providers
  disambiguation note.
- Note that rpk ai help, version, and unknown subcommands no longer
  prompt for authentication (redpanda #30360).
- Cross-link the new rate-card override section from the dashboard
  overview and from the transcripts page; clarify Anthropic
  cache-creation token attribution in the transcripts cost section.

Draft the two empty BYOA stubs against current cloudv2 state:

- agents/byoa-register.adoc: forward-looking how-to anchored on the
  AgentRegistryService API surface and the well-known A2A agent-card
  contract. The BYOA arm of AgentCreate.agent_type and the UI route
  are not yet defined; TODO comments mark every spot that needs the
  click-by-click flow once eng confirms.
- observability/byoa-telemetry.adoc: minimum required spans contract
  (resource attributes plus gen_ai.* span attributes), recommended
  enrichment, span hierarchy, validation walkthrough, and
  troubleshooting.

Strip forward-looking version framing across the repo:

- Delete the agent-network.adoc and violations.adoc stubs (their
  content was entirely "Coming in a later release" placeholder
  framing) and remove their nav entries.
- Drop "What's coming in a later release" sections from the dashboard
  overview and budgets pages; move roadmap items into TODO comments
  so reviewers can see them but customer prose stays current-state.
- Remove all V0/V1/V2/GA/general availability/2026-06-15 framing from
  customer prose (still allowed in TODO comments). Replace
  "in a later release", "today's release", "current release",
  "currently planned", "available today" qualifiers throughout.
- Mark four pre-existing forward-looking phrases with
  TODO(review-before-publish) so reviewers can grep for the tag and
  decide each before merge: Cost & usage "in development" admonitions
  on ai-gateway/overview.adoc and connect-agent.adoc, Auth0/Zitadel
  IdP migration mention on remote-mcp-clients.adoc, "not currently
  supported" cross-agent calling on agents/overview.adoc, and
  "currently registered" softener on managed-catalog.adoc.

Apply docs-team-standards style fixes to all new writing:

- Convert em dashes in bullet definition lists to colons; convert
  mid-sentence em dashes to commas, parens, or sentence breaks.
- Replace banned terms: "via" reworded; "Understand" learning
  objective verb replaced with "Identify".
- Add intro text before tables, lists, and code blocks under
  every heading that previously had none.
- Remove directional language ("below", "in the previous section");
  reword as "in this section" or by section name.
- Remove quotation marks per the no-quotes rule.

npm run build reports zero adp-docs errors.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP requested a review from a team as a code owner May 8, 2026 21:36
@netlify
Copy link
Copy Markdown

netlify Bot commented May 8, 2026

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

Name Link
🔨 Latest commit e37fcd0
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-agentic-data-plane/deploys/69fe575fe2e6d9000846b667
😎 Deploy Preview https://deploy-preview-15--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.

@micheleRP micheleRP merged commit 924d024 into main May 8, 2026
4 checks passed
@micheleRP micheleRP deleted the adp-may8-eng-sync branch May 8, 2026 21:40
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.

1 participant