Skip to content

docs(dlp): add DLP Overview page + surface stub/env-var gaps#208

Merged
cdot65 merged 1 commit into
mainfrom
cdot65/dlp-docs-overview
May 26, 2026
Merged

docs(dlp): add DLP Overview page + surface stub/env-var gaps#208
cdot65 merged 1 commit into
mainfrom
cdot65/dlp-docs-overview

Conversation

@cdot65

@cdot65 cdot65 commented May 26, 2026

Copy link
Copy Markdown
Owner

Summary

  • DLP section in the sidenav was structured differently from peer sections under Runtime Security — every other peer (Guardrail Optimization, Runtime Security itself, Red Teaming, Model Security) ships an Overview page; DLP did not.
  • Adds runtime/dlp/overview.md with the 20-command map, auth/env, resource model, shared merge-patch UX, and a "common gotchas" block.
  • Surfaces three documentation gaps callers were hitting:
    • profiles delete is a stub that exits 2 with the patch idiom — now in the commands table + dedicated section on profiles.md.
    • PANW_DLP_ENDPOINT was set in .env.example and read by the config loader, but never reached reference/environment-variables.md.
    • DLP was not reachable from the Runtime Security overview grid — added a card.

Files

  • docs/runtime/dlp/overview.md (new) — 20-command map, resource model (mermaid), shared patch UX, gotchas
  • docs/SUMMARY.md — Overview as first child under DLP
  • docs/runtime/dlp/profiles.mddelete row + ## delete section
  • docs/reference/environment-variables.mdPANW_DLP_ENDPOINT row
  • docs/runtime/overview.md — DLP card in grid
  • .changeset/docs-dlp-overview.md (patch)

Test plan

  • mkdocs build passes on CI (literate-nav resolves new SUMMARY entry)
  • Sidenav renders DLP → Overview as first child, matching Guardrail Optimization pattern
  • Mermaid block renders on the Overview page

…_ENDPOINT

DLP section in the sidenav lacked an entry page — peer sections (Guardrail
Optimization, Runtime Security) all have Overview. Adds runtime/dlp/overview.md
with 20-command map, auth, resource model, shared patch UX, gotchas.

Also:
- profiles.md: document delete stub (exits 2, prints patch idiom) — was
  missing from commands table.
- reference/environment-variables.md: add PANW_DLP_ENDPOINT.
- runtime/overview.md: cross-link DLP from grid cards.
- SUMMARY.md: Overview as first child under DLP.
@cdot65 cdot65 merged commit 9e54e8c into main May 26, 2026
5 checks passed
@cdot65 cdot65 deleted the cdot65/dlp-docs-overview branch May 26, 2026 20:56
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