Skip to content

Add Agentic Data Plane (ADP) documentation support#170

Merged
JakeSCahill merged 25 commits into
mainfrom
feature/add-adp-docs
Jun 15, 2026
Merged

Add Agentic Data Plane (ADP) documentation support#170
JakeSCahill merged 25 commits into
mainfrom
feature/add-adp-docs

Conversation

@JakeSCahill

@JakeSCahill JakeSCahill commented Apr 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds ADP (Agentic Data Plane) documentation support with dynamic homepage product card links.

Changes

ADP Documentation Integration

  • Add adp-docs repository as content source in all playbooks:
    • antora-playbook.yml (production)
    • local-antora-playbook.yml (local development)
    • preview-antora-playbook.yml (preview builds)
  • Add ADP homepage card with icon
  • New ADP icon: home/modules/ROOT/images/adp.svg

Dynamic Product Card Links

Adds page attributes for all product cards to enable dynamic link resolution in UI templates:

Attribute Target Page
:page-cloud-quickstart: redpanda-cloud:get-started:index.adoc
:page-cloud-docs: redpanda-cloud:home:index.adoc
:page-self-managed-quickstart: ROOT:get-started:quick-start.adoc
:page-self-managed-docs: ROOT:home:index.adoc
:page-connect-quickstart: redpanda-connect:get-started:quickstarts/index.adoc
:page-connect-docs: redpanda-connect:get-started:about.adoc
:page-adp-quickstart: redpanda-adp:get-started:signup.adoc
:page-adp-docs: redpanda-adp::index.adoc

Purpose

  • Enable ADP documentation rendering at /redpanda-adp/
  • Allow UI templates to dynamically resolve product card navigation links rather than hardcoding URLs
  • Support component renames without breaking homepage links

Test plan

  • Build site locally with adp-docs content
  • Verify ADP card appears on homepage with icon
  • Verify all product card links resolve correctly

Related

🤖 Generated with Claude Code

JakeSCahill and others added 2 commits April 22, 2026 12:39
- Add adp-docs repository to antora-playbook.yml content sources
- Add adp-docs to preview-antora-playbook.yml for Netlify previews
- Update llms.adoc ADP links from cloud-docs ai-agents paths to adp-docs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add Agentic Data Plane card to docs homepage
- Add ADP icon (cable/connector icon in Redpanda orange)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@JakeSCahill JakeSCahill requested a review from a team as a code owner April 23, 2026 13:26
@netlify

netlify Bot commented Apr 23, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-documentation ready!

Name Link
🔨 Latest commit 173291f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-documentation/deploys/6a30176d9db1f40008d7e096
😎 Deploy Preview https://deploy-preview-170--redpanda-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 86 (🟢 up 20 from production)
Accessibility: 92 (🔴 down 4 from production)
Best Practices: 92 (🟢 up 9 from production)
SEO: 83 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

JakeSCahill and others added 2 commits April 24, 2026 12:53
Update playbook to reference cloud-docs feature/remove-remote-mcp branch
which removes deprecated ADP documentation. Also removes adp-docs source
since ADP docs are not being released yet.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@JakeSCahill JakeSCahill marked this pull request as draft April 24, 2026 12:03
JakeSCahill and others added 3 commits April 24, 2026 13:48
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Update local and preview playbooks to use cloud-docs feature/remove-ai-agents
branch and remove adp-docs (not being released yet).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Adds Antora resource ID attributes for home page product card navigation:

- :page-cloud-quickstart: / :page-cloud-docs: - Cloud product links
- :page-self-managed-quickstart: / :page-self-managed-docs: - Self-Managed links
- :page-connect-quickstart: / :page-connect-docs: - Connect product links
- :page-adp-quickstart: / :page-adp-docs: - Agentic Data Plane links

These attributes allow the UI template to dynamically resolve navigation
links rather than hardcoding them.

Related: redpanda-data/docs-ui#376
JakeSCahill and others added 3 commits June 5, 2026 10:50
…sting

Switch from jakepartusch/wait-for-netlify-action to kamranayub/wait-for-netlify-action
which uses the Netlify API to wait for the deployment matching the specific commit SHA,
rather than returning any available deploy preview.

Previously, tests ran against stale cached deploys from earlier commits because the
action would find and return an old preview deploy instantly (~1 second), before the
fresh build for the latest commit was ready. This caused tests to fail because they
were checking against outdated site structure where pages existed at /25.3/home/
instead of /streaming/25.3/home/.

The new action requires a NETLIFY_TOKEN secret but ensures tests always run against
the correct deploy for the current commit, preventing false failures from stale content.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Relocate the 'How to Use These Docs' page from data-platform component to
home component for better discoverability and organization.

Changes:
- Move how-to-use-these-docs.adoc from data-platform/modules/ROOT/pages/ to home/modules/ROOT/pages/
- Update home navigation to reference local file instead of cross-component xref
- Remove from data-platform navigation
- Add page alias for old data-platform path to maintain backward compatibility
- Add Agentic Data Plane (ADP) to documentation structure hierarchy
- Include ADP in key components list with xref to agentic-data-plane component
- Add "Choose your path" section for ADP users with quickstart link

The ADP component is sourced from the adp-docs repository and provides
documentation for AI agent infrastructure and agentic workflows.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@JakeSCahill JakeSCahill force-pushed the feature/add-adp-docs branch from 356bcc2 to b7f033b Compare June 5, 2026 10:19
JakeSCahill and others added 9 commits June 5, 2026 14:56
Switch from GitHub URL to local worktree for adp-docs to enable
building with local changes on the feat/landing-page branch,
which includes the home module needed for xrefs.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Switch from GitHub URL to local worktree for streaming docs to use
local changes that remove broken ai-agents:mcp/local xrefs from
rpk cloud mcp partials.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Remove duplicate page attributes from home/index.adoc that used
  incorrect component names (redpanda-cloud, redpanda-connect, redpanda-adp)
  which would override the correct attributes (cloud-data-platform, connect,
  agentic-data-plane)
- Update local-antora-playbook.yml to use remote GitHub URLs for all
  content sources, matching production and preview playbooks

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The kamranayub action requires NETLIFY_TOKEN secret which is not
configured. Revert to the original action that works without
authentication.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@JakeSCahill JakeSCahill marked this pull request as ready for review June 12, 2026 13:59

@kbatuigas kbatuigas 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.

Approving so there are no blockers for Monday, but some flags just in case:

  1. High: production/preview playbooks are pinned to a feature branch
  • antora-playbook.yml and preview-antora-playbook.yml now point cloud-docs to feature/remove-ai-agents instead of main.
  • This introduces long-term coupling to a non-default branch and can break builds if that branch is deleted or rewritten.
  • Suggestion: switch both back to main, or explicitly document this as a short-lived exception with a follow-up task/date.
  1. High: local playbook includes a machine-specific UI path
  • local-antora-playbook.yml points to /Users/jakecahill/Documents/docs-ui/build/ui-bundle.zip.
  • This is not portable and will fail for other contributors.
  • Suggestion: restore the shared release URL (or use a local override file that is not committed).
  1. Medium: ADP landing page target is inconsistent
  • home/antora.yml uses agentic-data-plane:ROOT:index.adoc.
  • New content links in home/modules/ROOT/pages/how-to-use-these-docs.adoc and home/modules/ROOT/pages/how-to-use-these-docs.adoc use agentic-data-plane:home:index.adoc.
  • Suggestion: align these to one canonical target to avoid unresolved/broken links.

JakeSCahill and others added 2 commits June 15, 2026 11:18
…aths

Fix broken links in llms.txt that pointed to non-existent cloud-data-platform paths.
Updated all AI agents section links to use correct agentic-data-plane paths:

- /cloud-data-platform/ai-agents/mcp.md -> /agentic-data-plane/connect/mcp-overview.md
- /cloud-data-platform/ai-agents/adp-overview.md -> /agentic-data-plane/get-started/adp-overview.md
- /cloud-data-platform/ai-agents/ai-gateway.md -> /agentic-data-plane/gateway/overview.md
- /cloud-data-platform/ai-agents.md -> /agentic-data-plane/connect/agents-overview.md
- /cloud-data-platform/ai-agents/observability.md -> /agentic-data-plane/monitor.md

This fixes 3+ broken links detected by afdocs llms-txt-links-resolve check.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
JakeSCahill and others added 4 commits June 15, 2026 14:12
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The redirect tests ran against the Netlify deploy preview before it was
fully ready, causing intermittent ECONNRESET failures unrelated to the
actual redirect rules (which Netlify validates on deploy). Remove the
flaky test, its workflow job, npm scripts, and documentation.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Stale links surfaced in the 404 form-submission feed were hitting two
consistent, fixable patterns:

- /streaming/<version>/rpk/* — rpk reference pages now live under
  /reference/rpk/ (the cloud-data-platform side already had this fix).
- /streaming/<version>/data-transforms/* — these pages now live under
  /develop/data-transforms/.

Both targets were verified to return 200 on production across versions.
Uses a :version placeholder to cover current and all supported versions
in one rule each.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@JakeSCahill JakeSCahill merged commit 6e7bf9a into main Jun 15, 2026
5 checks passed
@JakeSCahill JakeSCahill deleted the feature/add-adp-docs branch June 15, 2026 15:24
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.

2 participants