Restructure modules into workflow groupings (step 1 of 2)#39
Conversation
Removes 24 pages that have no content beyond a TODO marker or are pure section indexes from the old module layout. Each is ~3-6 lines. Notable: governance/guardrails/cost-tracking.adoc is eng-blocked per the ADP GA Readiness Plan Track A; drop now and add back when content lands. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The Agent and AI Gateway quickstarts join the existing get-started/byoc-quickstart.adoc and adp-overview.adoc, so all quickstart paths share one module. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Folds three previous noun-based modules into one workflow-based module covering 'Connect data & tools': - agents/ (declarative agent + BYOA + concepts + system-prompts + architecture + integration + pipeline-integration + tutorials) - mcp/ (create-server + register-remote + user-delegated-oauth + oauth-providers + test-tools + managed catalog + connectors) - integrations/ (claude-code + remote-mcp-clients) Two forced renames due to filename collision: - agents/overview.adoc -> connect/agents-overview.adoc - mcp/overview.adoc -> connect/mcp-overview.adoc Step 2 will revisit those renames (likely merge into one overview). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Folds observability and troubleshooting into one workflow-based module covering 'Monitor & debug': - observability/ (transcripts + byoa-telemetry + ingest-custom-traces + logs + metrics + concepts) - agents/troubleshoot/troubleshoot-ai-agents.adoc (flattened out of the troubleshoot/ subdir) - agents/monitor.adoc (kept filename for step 1; will rename to monitor-agents.adoc in step 2 to avoid /monitor/monitor/ URL) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Renames governance/ to control/ for the 'Control & govern' workflow. Preserves dashboard/ and guardrails/ subdirectories. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Renames ai-gateway/ to gateway/ for the 'Routing & LLM settings' workflow grouping. Matches product terminology (AI Gateway). Preserves admin/ and builders/ subdirectories. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Moves cross-module partials adjacent to the pages that include them,
and removes the older duplicate copies that lived in two places.
- ROOT/partials/integrations/* -> connect/partials/integrations/
- ROOT/partials/service-account-authorization.adoc -> connect/partials/
- observability/partials/* -> monitor/partials/
- Dedupe: drop ROOT/partials/{observability-logs,observability-metrics,
transcripts-ui-guide}.adoc (the observability/ copies are newer)
- Dedupe: drop integrations/partials/integrations/* (identical to the
moved connect/partials/integrations/* set)
- Dedupe: drop ROOT/partials/byoc-aws-requirement.adoc (identical to
the get-started/partials/ copy)
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
519 replacements across 72 files. Exception rewrites first (paths that don't fit the bulk pattern due to forced renames or quickstart moves to get-started/), then bulk module-prefix swaps: xref:agents: -> xref:connect: xref:mcp: -> xref:connect: xref:ai-gateway: -> xref:gateway: xref:observability: -> xref:monitor: xref:governance: -> xref:control: xref:integrations: -> xref:connect: Exceptions: xref:agents:quickstart.adoc -> xref:get-started:quickstart.adoc xref:ai-gateway:gateway-quickstart...-> xref:get-started:gateway-quickstart.adoc xref:agents:overview.adoc -> xref:connect:agents-overview.adoc xref:mcp:overview.adoc -> xref:connect:mcp-overview.adoc xref:agents:troubleshoot/... -> xref:monitor:troubleshoot-ai-agents.adoc xref:agents:tutorials/ -> xref:connect:tutorials/ ROOT partial includes also rewritten to point at the new module homes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
For every page that moved, the destination file carries an alias to the old module:path so existing URLs (and bookmarks, blog links, etc.) keep resolving via Antora's built-in redirect machinery. 59 pages affected. Files that already had aliases to historical locations (cloud-data-platform:ai-agents:*) keep those entries; the new in-repo alias is appended to the comma-separated list. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replaces the old noun-based nav (Agents / MCP Servers / AI Gateway / Governance / Observability / Integrations / Reference) with the workflow shape proposed in PR #38, now pointing at the new module homes (connect/, monitor/, control/, gateway/). Concepts section dropped per team feedback ("don't separate out all concepts; docs and cloud-docs don't do that"). Concept pages still build under their workflow modules and remain reachable by URL. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Removes the now-empty modules/agents, /mcp, /ai-gateway, /observability, /governance, /integrations directories. Their content moved into the new workflow modules in prior commits. Cleanup along the way: - Delete modules/agents/examples/agents/*.txt — byte-identical duplicates of ROOT/examples/agents/*.txt which are the canonical copies actually referenced by includes. - Move modules/mcp/doc-detective-*.json into modules/connect/ since the pages they test now live there. Final module set: connect, control, gateway, get-started, monitor, reference, ROOT, shared. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Six bare 'xref:troubleshoot/troubleshoot-ai-agents.adoc' references (intra-module refs from the old agents/ module) now use the explicit 'xref:monitor:troubleshoot-ai-agents.adoc' since the file moved to monitor/. References to dropped section-index pages updated or removed: - guardrails/index.adoc -> guardrails/overview.adoc - dashboard/index.adoc -> dashboard/overview.adoc - connect:index.adoc -> dropped from Next steps lists; gateway setup-guide points at Claude Code + remote MCP clients instead. References to the dropped cost-tracking.adoc removed inline. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Frames the rpk install page as reference material rather than a quickstart prerequisite. The 'rpk ai' command set is still beta this release, so we don't want to surface rpk installation as the headline path. The nav slot stays under Settings reference where it already lived. Adds :page-aliases: get-started:rpk-install.adoc so the prior URL keeps resolving. Updates the two inline xrefs in monitor/ingest-custom-traces and connect/tutorials/transaction-dispute-resolution. Co-Authored-By: Claude Opus 4.7 (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. |
Renames the awkward modules/monitor/pages/monitor.adoc (URL was /monitor/monitor/) to monitor-agents.adoc. Updates the six xrefs that pointed at the old name. Resolves Open Question #1 from PR #39. Also drops the in-repo :page-aliases: entries added earlier in this PR. These URLs (agents:create-agent.adoc, mcp:overview.adoc, etc.) have never shipped publicly, so there's no published path to preserve. The cross-repo aliases (cloud-data-platform:ai-agents:* and develop:*) are kept because cloud-docs's published content still links to them. One pre-existing in-repo alias was restored: reference:rpk/rpk-profile.adoc on rpk-profile/rpk-profile.adoc (three rpk-cloud pages link via the shorter path) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The single 'rpk command reference' entry was hiding ~50 rpk command pages. This restores the full subtree under that entry so each command is reachable from the left nav. Subtree includes rpk ai (with deeply nested mcp tools / oauth / oauth-client subcommands), rpk cloud (login/logout/cluster), rpk profile, and rpk -X. All 50 rpk reference files now appear in the nav. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Antora's docs-ui only treats nav items as expandable when they're xrefs to a real page; plain-text labels like '* Quickstarts' render but keep their children hidden. That collapsed the six new workflow sections and, nested under one of them, the entire rpk command reference subtree. Five new index.adoc files (connect, monitor, control, gateway, reference) follow the existing :page-layout: index pattern so the section landing page auto-renders a card grid of its children. The Quickstarts header reuses get-started/adp-overview.adoc (the start page); the redundant 'Overview' sub-item under Quickstarts is dropped. After this change, every section header is a real xref, every section expands, and the rpk command subtree is visible under Settings reference. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Be sure to update your navtree entries--this is just a first pass/attempt: Connect Data & Tools (use our navtree top level capitalization/init caps) Monitor & Debug Control & Govern Routing & LLM Settings Settings Reference |
Context
The team likes the prototype's IA framing (Connect data & tools, Monitor & debug, Control & govern, Routing & LLM settings via AI Gateway) and wants to adopt those workflow groupings, but compromised for the first release to stay consistent with the docs and cloud-docs repos:
get-started/as a module — both docs and cloud-docs use this name; preserves several file paths and matches sibling-repo convention.agents/tutorials/*becomesconnect/tutorials/.This is step 1 of a two-step rollout. Step 1 moves files into new module directories and keeps the original filenames intact wherever possible. Step 2 (separate PR, later) will rename pages to align with verb-oriented labels.
Preview page
Overview
New module layout
8 modules total (was 10). The retired ones are
agents,ai-gateway,governance,observability,integrations,mcp— their content redistributes across the new workflow modules.rpk-install.adocmoved intoreference/(wasget-started/) so it doesn't compete for attention with the quickstart pages.New
nav.adocThe Concepts section from PR #38's nav is removed; concept pages are still in the build (under their workflow modules) but don't get their own nav section.
What changed (per commit, in order)
governance/guardrails/cost-tracking.adocis dropped because it's eng-blocked per the ADP GA Readiness Plan Track A.get-started/—agents/quickstart.adocandai-gateway/gateway-quickstart.adocjoin the existingadp-overview.adocandbyoc-quickstart.adoc.connect/module — foldsagents/,mcp/,integrations/content (create-agent, BYOA, MCP server creation/registration/OAuth, managed catalog, IDE integrations, tutorials, agent concepts). Two forced renames due to filename collisions:agents/overview.adoc→agents-overview.adoc;mcp/overview.adoc→mcp-overview.adoc.monitor/module — replacesobservability/, plus pulls inagents/troubleshoot/troubleshoot-ai-agents.adocandagents/monitor.adoc.control/module — renamesgovernance/tocontrol/. Preservesdashboard/andguardrails/subdirs.gateway/module — renamesai-gateway/togateway/. Preservesadmin/andbuilders/subdirs.ROOT/partials/integrations/*→connect/partials/; observability partials →monitor/partials/. Deduplicates 14 redundant partials.xref:agents:→xref:connect:, etc.).:page-aliases:entries — 59 moved pages each carry an alias to the old<module>:<path>.adocso existing URLs (bookmarks, blog links, support tickets) keep resolving. Existing aliases (e.g. tocloud-data-platform:ai-agents:*) are preserved.nav.adoc— drops the old 132-line noun-based shape; adopts the workflow grouping with conversationalxref:[Label]overrides.agents/,mcp/,ai-gateway/,observability/,governance/,integrations/deleted now that everything's moved.xref:troubleshoot/troubleshoot-ai-agents.adocrefs (intra-module before the move) now use the explicitxref:monitor:prefix; refs to dropped section-index pages updated or removed.rpk-installintoreference/— frames it as reference material rather than a quickstart prerequisite.rpk aiis still beta this release, so we don't want to surface rpk installation as a headline path.Move summary
124 files changed: 538 insertions, 9671 deletions (most of the deletions are git counting renames as add+delete in line counts, but they're true
Rrenames in git history —git blameis preserved).Backwards compatibility
The new workflow-module URLs (
/connect/,/monitor/,/control/,/gateway/) and the prior noun-module URLs (/agents/,/mcp/,/ai-gateway/, etc.) have never shipped publicly — this is a pre-launch restructure. So we don't add new:page-aliases:entries for in-repo path changes; nothing externally links those paths.The five pre-existing aliases pointing at cloud-docs paths (
cloud-data-platform:ai-agents:*anddevelop:*) are preserved unchanged, because cloud-docs's published content still links to those paths. One pre-existing in-repo alias (reference:rpk/rpk-profile.adocon the rpk-profile single-source stub) is also kept because three rpk-cloud pages link via the shorter path.Open questions
Captured here so the team can override before this lands:
connect/agents-overview.adoc+connect/mcp-overview.adoc— twooverview.adocfiles collided inconnect/. Step 2 idea: merge into a singleconnect/overview.adoc(or drop both if redundant once we look at them together).connect/pages/tutorials/keeps the tutorials together as a sub-tree. If later we want a top-level Tutorials section, the move is easy.connect/concepts.adoc,monitor/concepts.adoc,connect/a2a-concepts.adoc, etc.). Step 2 can decide whether to surface them in a nav Concepts section or merge into workflow intros.What's out of scope (step 2 work)
create-server.adoc→build-tool-server.adoc). The conversational nav labels currently live asxref:[Label]overrides; step 2 makes the URL match the label.agents-overview.adoc+mcp-overview.adocmerge into a singleconnect/overview.adoc.Test plan
npm run buildexits clean (only pre-existing rpk-ai table warnings, unchanged)cloud-data-platform:ai-agents:*) preserved on the original carrier pagesRingit log(blame history preserved)🤖 Generated with Claude Code