Reapply PR #559: AI Gateway documentation rewrite for ADP GA#2
Reapply PR #559: AI Gateway documentation rewrite for ADP GA#2
Conversation
This reapplies changes from cloud-docs PR #559 by @micheleRP: redpanda-data/cloud-docs#559 ## Changes from original PR **AI Gateway restructure for ADP GA release:** - Updated overview.adoc with consolidated conceptual content - Updated configure-provider.adoc as primary how-to guide grounded in llm_provider.proto - Updated connect-agent.adoc with OIDC authentication patterns - Updated index.adoc as landing page emphasizing Redpanda as managed LLM API proxy The documentation now follows simplified navigation and includes page aliases for legacy URLs. Co-Authored-By: Michele Cyran <micheleRP@users.noreply.github.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Updates the four AI Gateway pages to match the cluster-embedded view
on adp-production as of 2026-04-28:
- Lead `connect-agent.adoc` with the rpai CLI flow (matches what the
provider detail page surfaces in `Install rpai CLI` + `rpai auth login`).
Demote manual OIDC client_credentials to a "CI and programmatic"
alternative, with TODO markers on standalone-ADP-specific values.
- Replace the "Overview tab / API Examples tab" framing with the actual
single-page layout: Connection card → Models → Cost & usage (Coming
soon) → Getting started → Connect your app → Delete this provider.
- Drop the unsettable Description identity field (proto exposes it on
the stored type but not on Create/Update; UI form has no field for it).
- Update Models story for Phase 1 ProviderModel + capability badges +
catalog-backed picker (lifted from adp-ui/src/routes/llm-providers/
create.tsx and the model card component).
- Update Anthropic example IDs to claude-sonnet-4-6 (was claude-sonnet-4-5;
live cluster ships claude-sonnet-4-6 / claude-opus-4-7 / claude-haiku-4-5).
- Rename Google "(Gemini)" → "Google AI" to match the picker label;
expand OpenAI-compatible examples to include Together / Groq / OpenRouter
per the picker description.
- Replace manual-curl verification step with the Test Connection
control + Show commands disclosure on the Verify connection panel.
- Add VPC/dataplane traffic-stays-in-your-network framing to overview.adoc
(lifted from the live UI's Getting started panel).
- Add "Cost & usage (Coming soon)" reference and cross-link to the
Budgets workflow's read-only spending visibility for the GA story.
- Use UI labels verbatim throughout: API key (not API key reference),
Auth passthrough (not Authorization passthrough).
- Cluster-embedded sign-in flow as primary ("open your cluster, expand
ADP, select LLM Providers"), with TODO markers for the standalone-ADP
rewrite once that surface ships.
- Cleanup: every `include::ai-agents:partial$adp-la.adoc[]` →
`include::ROOT:partial$adp-la.adoc[]`. Every `xref:ai-agents:ai-gateway/*`
→ intra-component `xref:*` form. Page-aliases prefixed with
`redpanda-cloud:ai-agents:` so cross-component redirects from old
cloud-docs URLs work.
Out of scope (separate cleanup PR):
- Deleting the legacy AI Gateway pages (gateway-quickstart, gateway-
architecture, aggregation, routing-cel, admin/setup-guide,
builders/discover-gateways) and retargeting the ~80 cross-module
xrefs from agents/integrations/observability partials. Tracked
inline in configure-provider.adoc:5.
- Drift in the standalone-ADP wording (sign-in URL, IAM model, OIDC
audience). Marked with TODOs throughout, to resolve when standalone
ADP launches.
Refs: cloud-docs#559 (original rewrite), DOC-2109. Verified against
proto/public/cloud/redpanda/api/adp/v1alpha1/llm_provider.proto and
apps/adp-ui/src/routes/llm-providers/ on cloudv2 main, plus screenshots
from the adp-production cluster.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Pushed What changed and why
Both pages: updated provider type framing to match the picker:
UI labels lifted verbatim from the live form: API key (not "API key reference"), Auth passthrough (not "Authorization passthrough"). Sign-in framing: leaned concrete on the cluster-embedded view that's live today (open your cluster → expand ADP → LLM Providers). Added TODO markers for the standalone-ADP rewrite when that surface ships. Cleanup: every Out of scope (separate cleanup PR)The original Standalone-ADP TODOsSeveral values are accurate today (cluster-embedded view) but will need a rewrite when standalone ADP ships. TODO-marked inline:
Verified against:
🤖 Generated with Claude Code |
2 participants
Summary
This reapplies changes from cloud-docs PR #559 by @micheleRP to the adp-docs repository.
Changes from Original PR
AI Gateway restructure for ADP GA release:
overview.adocwith consolidated conceptual contentconfigure-provider.adocas primary how-to guide grounded inllm_provider.protoconnect-agent.adocwith OIDC authentication patternsindex.adocas landing page emphasizing Redpanda as managed LLM API proxyThe documentation now follows simplified navigation and includes page aliases for legacy URLs.
Original PR Details
Preview pages
Testing
🤖 Generated with Claude Code