Skip to content

Convert :personas: metadata to product-design-approved ADP vocabulary#31

Merged
micheleRP merged 3 commits into
mainfrom
chore/personas-adp-vocabulary
May 26, 2026
Merged

Convert :personas: metadata to product-design-approved ADP vocabulary#31
micheleRP merged 3 commits into
mainfrom
chore/personas-adp-vocabulary

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 26, 2026

Summary

  • Replaces the prior 7-slug ad-hoc persona list (app_developer, agent_developer, ai_agent_developer, platform_admin, evaluator, streaming_developer, data_engineer) with 5 role-based slugs sourced from the ADP product persona set: security_compliance_lead, platform_engineer, agent_builder, domain_evaluator, pilot_lead.
  • Adds docs-data/personas.yaml as the canonical registry for the slugs, matching the schema used in cloud-docs, rp-connect-docs, and redpanda-labs. Slugs are descriptive role names — no character names appear anywhere in the registry or in page metadata.
  • Touches only pages that already had a :personas: line. Pages that previously lacked the attribute remain untagged in this PR.

Why

The previous persona vocabulary was undefined and inconsistent — 7 slugs in use, no central registry, no agreed semantics, and a clear duplicate (agent_developer vs ai_agent_developer). Product design recently produced 7 named personas for the ADP product; this PR aligns the documentation persona vocabulary to that set (using the 5 personas that have an actual doc-reading audience — skipping Tom, who "will not read documentation," and David, an exec-narrative consumer).

Each updated page's :personas: line was chosen by reading the page (intro paragraph, topic type, learning objectives, tasks documented) and picking the 1–3 personas that genuinely match its audience — not a mechanical slug-to-slug rewrite.

Persona distribution across 93 updated pages

Slug Total occurrences
platform_engineer 71
agent_builder 65
security_compliance_lead 19
pilot_lead 5
domain_evaluator 4

The shape matches the doc surface: platform/build are the bulk; governance, rollout, and verification are appropriately narrow. (Pages can list multiple personas, so totals exceed the page count.)

Preview pages

This PR touches ~90 page files with one-line metadata changes; :personas: is not user-visible in the rendered HTML, so a single entry-point preview is enough.

Test plan

  • Local npm run build succeeds; only pre-existing warnings (CSV data, attribute-validation for Agentic AI/AI categories, unlisted-pages) — none persona-related
  • No orphan legacy slugs remain (grep with word boundaries returns nothing)
  • No persona-related // TODO: confirm persona vocabulary comments remain in governance pages
  • Reviewer spot-check: open a few pages from different modules and confirm the persona assignments make sense — e.g., governance/permissions-overview, agents/monitor, ai-gateway/configure-provider, observability/transcripts

Follow-ups (out of scope for this PR)

  • Bringing the 45 previously-untagged pages (index pages, reference pages, stubs) into the new persona vocabulary in a separate PR once the team confirms whether those page types should carry persona metadata at all.
  • Whether the existing :personas: slugs in cloud-docs, rp-connect-docs, and redpanda-labs should also be reconciled to the ADP-product vocabulary. Today each repo is sovereign and overlapping slugs (agent_developer, platform_admin) have slightly different meanings across repos.
  • Whether to add an Antora extension that validates :personas: values against docs-data/personas.yaml at build time (none of the repos enforce this today).

🤖 Generated with Claude Code

Replace the prior 7-slug list (app_developer, agent_developer,
ai_agent_developer, platform_admin, evaluator, streaming_developer,
data_engineer) across every .adoc page with 5 role-based slugs sourced
from the ADP product persona set:

* security_compliance_lead
* platform_engineer
* agent_builder
* domain_evaluator
* pilot_lead

Add docs-data/personas.yaml as the canonical registry, matching the
schema used in cloud-docs, rp-connect-docs, and redpanda-labs. Slugs
are descriptive role names; no character names appear in the registry
or in page metadata.

Each page's :personas: line was chosen by reading the page (intro,
topic type, learning objectives) and picking the 1-3 personas that
genuinely match its audience. :personas: is also added to 45 pages
that previously lacked it (index pages, reference pages, stubs).
Pure include fragments (no document title or description) are
intentionally left untagged; they inherit personas from the including
page.

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 26, 2026 22:29
@netlify
Copy link
Copy Markdown

netlify Bot commented May 26, 2026

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

Name Link
🔨 Latest commit 35df77c
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-agentic-data-plane/deploys/6a16245dfe564200083fdd6c
😎 Deploy Preview https://deploy-preview-31--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 and others added 2 commits May 26, 2026 16:45
Per follow-up review, this PR should only update pages that already
carried :personas:. Pages that did not have the attribute before
(index pages, reference pages, stubs) should not gain it as part of
this vocabulary swap.

Drops the :personas: line from 45 files that this branch had newly
tagged. No other changes; the 93 pages with pre-existing :personas:
metadata keep their newly-assigned slugs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP merged commit e347d11 into main May 26, 2026
4 checks passed
@micheleRP micheleRP deleted the chore/personas-adp-vocabulary branch May 26, 2026 22:57
@micheleRP micheleRP mentioned this pull request May 26, 2026
7 tasks
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