Audit ADP landing page and replace glossary stub for GA#13
Merged
Conversation
Closes the §3A R1 (adp-docs side) and §3A R2 commitments in the master
ADP Docs Plan.
Landing page (modules/ROOT/pages/index.adoc) - 5 surgical edits:
1. Replace banned word "leverage" in Use cases lead.
2. Add a Governance section between AI Gateway and Enterprise
governance, pointing to governance:dashboard/index.adoc.
3. Use cases lead now reads "Common Redpanda ADP use cases include:"
so the bullets get an intro line per docs-team-standards.
4. Use cases bullets unchanged (deployment-agnostic; do not import
PSD-derived examples while ADP Cloud descope is pending).
5. Refactor Next steps to bare-xref form and add a Governance bullet.
Glossary index (modules/reference/pages/glossary.adoc):
- Replace the 11-line stub xref list with an index page that points
to the canonical Redpanda glossary on shared and surfaces 17
ADP-relevant glossterm tooltips.
- The 10 new terms (tool, resource, declarative agent, BYOA, OAuth
Provider, OAuth Client, OAuth Connection, Token Vault, spending
event, Governance Dashboard) render as "not yet defined" until the
companion docs#shared PR merges; existing terms render normally.
Companion: redpanda-data/docs#1691 adds the 10 new term partials.
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. |
Per follow-up direction, relax the no-PSD-content rule for the overview page only and pull selective framing from the portfolio strategy docs. Stays deployment-agnostic (Cloud descope risk pending) and keeps to docs voice (no AI-tells, no em dashes, no rule-of-three lists). - Use cases: replace 3 generic bullets with 5 PSD-spanning examples across financial operations, HR/people ops, customer experience, infrastructure operations, and productivity tools. Keeps generic system categories (HRIS, ERP) over vendor-specific lock-in. - AI Gateway: add the multi-model routing framing (frontier model for analysis, smaller model for triage, single cost view) drawn from the Cloud strategy's "multi-model routing" differentiator. - Enterprise governance compliance bullet: name ISO 42001 and the EU AI Act as concrete frameworks, drawn from the BYOC strategy's offensive-compliance differentiator. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Disambiguate from the new == Governance section above (which points to the Governance Dashboard product). Built-in governance controls is about cross-cutting principles (security, authorization, observability, compliance) and reads as such. No xrefs target the section anchor; safe to rename. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
ADP Cloud is out of the 2026-06-15 GA. Sweep the repo to remove the remaining Cloud-specific surface area: - Delete the empty modules/get-started/pages/signup.adoc stub (only contained an "Add content" TODO under a Cloud-only flag). - modules/ROOT/nav.adoc: drop the signup nav entry; rename the BYOC prereqs/quickstart link text to drop the "ADP BYOC" prefix per the Cloud-descope guidance to prefer "ADP" alone in shared assets. - modules/get-started/pages/index.adoc: replace the description's Cloud signup framing with deployment-agnostic wording. - modules/agents/pages/quickstart.adoc: drop the "agents are not available on ADP Cloud yet" parenthetical from the prereq list. - modules/ROOT/partials/availability-block.adoc: collapse the partial to a single :page-byoc: branch; the Cloud-only and Cloud+BYOC branches no longer apply. The 6 pages currently tagged :page-byoc: true keep that attribute so the auto-injected "Available in: BYOC" admonition keeps rendering; suppressing the admonition entirely is a docs-ui change tracked separately. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The "Available in: Cloud, BYOC" / "Available in: BYOC" admonition is injected by the docs-ui v2.14.0-adp.2 bundle's partials/article.hbs. With ADP Cloud descoped from the 2026-06-15 GA, that block no longer serves a purpose: BYOC is the only deployment shape, so the admonition adds visual noise without informing the reader. Override the bundled article.hbs locally via Antora's supplemental_files mechanism. The override is identical to the bundled template except the ADP availability block (lines 50-100 in the original) is removed. Suppresses the admonition on the deploy preview build immediately. The docs-ui repo needs the same change before the next docs-ui release for the production build to match; tracked separately. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4 tasks
micheleRP
added a commit
to redpanda-data/docs-ui
that referenced
this pull request
May 6, 2026
ADP Cloud is descoped from the 2026-06-15 GA. With BYOC as the only deployment shape, the "Available in: Cloud, BYOC" / "Available in: BYOC" admonition no longer informs the reader and adds visual noise on every ADP page. Drop the entire `page.attributes.adp` availability block from src/partials/article.hbs. Other badges (beta, limited-availability, context-switcher, BYOC/Cloud labels for non-ADP pages) keep working unchanged. Companion PR: redpanda-data/adp-docs#13 ships the same change locally via Antora's supplemental_files mechanism so the deploy preview is fixed immediately. Once a new docs-ui release tag is cut from this branch and the adp-docs / docs-site playbooks are bumped to it, the supplemental override in adp-docs becomes redundant and can be deleted. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
micheleRP
commented
May 6, 2026
micheleRP
commented
May 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes the §3A R1 (adp-docs side) and §3A R2 commitments in the ADP Docs Plan, plus a sweep to remove ADP Cloud mentions following the 2026-05-06 GA descope decision.
modules/ROOT/pages/index.adoc— landing-page audit== Governancesection between AI Gateway and the cross-cutting governance section, with an xref togovernance:dashboard/index.adoc. Surfaces the Governance Dashboard product line that shipped in PRs docs(governance): add Governance Dashboard pages for ADP GA #5 and Update ADP docs for May 4 batch (rpk ai, Bedrock GA, governance V0) #11.== Enterprise governancesection to== Built-in governance controlsto disambiguate from the new Governance section above it.modules/reference/pages/glossary.adoc— replace stub with indexThe 11-line stub was a dead xref list (anchors weren't defined on the page). Replaced with an index page that:
shared.glossterm:macros with hover tooltips.The 10 new terms (
tool,resource,declarative agent,BYOA,OAuth Provider,OAuth Client,OAuth Connection,Token Vault,spending event,Governance Dashboard) currently render as not yet defined until redpanda-data/docs#1691 merges and propagates to the preview build. Existing entries render normally.ADP Cloud descope sweep
ADP Cloud is out of the 2026-06-15 GA. Removed remaining Cloud-specific surface area:
modules/get-started/pages/signup.adocstub (only contained an "Add content" TODO under a Cloud-only flag).modules/ROOT/nav.adoc: dropped the signup nav entry; renamed the BYOC prereqs/quickstart link text to drop the "ADP BYOC" prefix per the descope guidance to prefer "ADP" alone in shared assets.modules/get-started/pages/index.adoc: replaced the Cloud signup framing in the description with deployment-agnostic wording.modules/agents/pages/quickstart.adoc: dropped the "agents are not available on ADP Cloud yet" parenthetical from the prereq list.modules/ROOT/partials/availability-block.adoc: collapsed to a single:page-byoc:branch; the Cloud-only and Cloud+BYOC branches no longer apply.The 6 pages currently tagged
:page-byoc: truekeep that attribute so the auto-injected "Available in: BYOC" admonition keeps rendering. Suppressing the admonition entirely is a docs-ui change tracked separately.Companion PR
modules/terms/partials/onshared. PR #1691 must merge first for the new tooltips to resolve here.Deliberately out of scope
byoc-prereqs.adocandbyoc-quickstart.adocfiles — bigger filename-rename lift; defer.:page-byoc: truefrom the 6 pages that have it — would cause docs-ui to render the default "Available in: Cloud, BYOC" admonition instead of "BYOC". Coordinate with docs-ui to suppress entirely.glossterm:Governance Dashboard[]/glossterm:declarative agent[]to first-mention spots elsewhere in adp-docs — sequencing dependency on PR #1691; can be a follow-up.Preview pages
Test plan
signup.adoc(no other page links to it).🤖 Generated with Claude Code