docs(governance): scaffold Guardrails pages for ADP GA#7
Merged
Conversation
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
8 tasks
Beta deliverable (master Week 3, May 4-8): single concept page covering INPUT/OUTPUT phase model, the three evaluator types (PII / Toxicity / Custom webhook), violation framing, and attachment scope. Anchors on RFC 0002 Phase 5; resource-model details left as TODO markers pending team-ai's post-pivot answer. GA deliverables (master Weeks 4-6): four pages stubbed with full outlines and TODO markers keyed to specific Open Questions in the Confluence companion plan, so live walkthroughs on adp-production can resolve them in place: - create-guardrail.adoc — how-to for configuring + attaching - types-reference.adoc — config schema reference per evaluator - violations.adoc — read & troubleshoot violations - cost-tracking.adoc — per-evaluator cost shape + capping Nav: replaces the flat governance:guardrails.adoc placeholder under Trust & Governance with a Guardrails parent + 5 children. The 3-line governance/pages/guardrails.adoc placeholder is deleted in this commit. Cross-link to governance:dashboard/index.adoc is transient-broken until adp-docs PR #5 (Governance Dashboard) merges; same pattern as Budgets PR #6. Refs: DOC-2113. Plan: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1881702438 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> # Conflicts: # modules/ROOT/nav.adoc
micheleRP
force-pushed
the
adp-guardrails-rewrite
branch
from
e964e16 to
f8fbb89
Compare
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
Scaffolds the Guardrails docs surface for the ADP GA push. Beta deliverable (master Week 3, May 4–8): single concept page covering the INPUT/OUTPUT phase model, the three evaluator types (PII / Toxicity / Custom webhook), violation framing, and attachment scope — fully written and ready to ship as best-effort beta content. GA deliverables (master Weeks 4–6): four pages stubbed with full outlines and
// TODO:markers keyed to specific Open Questions in the Confluence companion plan, so live walkthroughs onadp-productioncan resolve them in place.governance/pages/guardrails/index.adoc— anchors on RFC 0002 Phase 5; resource-model details left as TODO markers pending team-ai's post-pivot answer (cloudv2 commitse0a1ba0ceeand7eff2ecbbfrestructured the proto after thephase5-aigw-guardrailsbranch was cut).create-guardrail.adoc(how-to),types-reference.adoc(per-type config schema reference),violations.adoc(read + troubleshoot violations),cost-tracking.adoc(per-evaluator cost shape + capping knobs).governance:guardrails.adocreplaced under Trust & Governance with a Guardrails parent + 5 children (Overview / Create / Types / Violations / Cost).governance/pages/guardrails.adocplaceholder.Refs: DOC-2113 · Confluence plan · master plan workflow #5
Doc owner: Joyce Fee (per 2026-04-21 Confluence comment); Michele drafted this scope.
Per-page status:
guardrails/index.adocguardrails/create-guardrail.adocguardrails/types-reference.adocguardrails/violations.adocguardrails/cost-tracking.adocOpen Questions tracked in Confluence (26 items, grouped A–D):
violations.adocandtypes-reference.adocpolish.Known transient-broken xref:
cost-tracking.adoccross-links toxref:governance:dashboard/index.adoc(Governance Dashboard sub-folder). That page is being added in adp-docs PR #5 and resolves once #5 merges. Same pattern as Budgets PR #6.Out of scope (separate workstreams):
governance/kill-switch.adoc) — BYOC-only; not a numbered workflowPreview pages
Test plan
aigwctl guardrailflow (or ADP UI if it ships) to fill TODO markersadp-la.adocpartial includes at GA🤖 Generated with Claude Code