Skip to content

docs: move webhook proxy to self-hosting and trim to operator scope#906

Open
alexluong wants to merge 3 commits into
mainfrom
docs/webhook-proxy-restructure
Open

docs: move webhook proxy to self-hosting and trim to operator scope#906
alexluong wants to merge 3 commits into
mainfrom
docs/webhook-proxy-restructure

Conversation

@alexluong
Copy link
Copy Markdown
Collaborator

Summary

Restructuring docs/outpost/features/webhook-proxy based on feedback that (a) it belongs in self-hosting (operator-configured via env var, no tenant-facing surface) and (b) the page is too deep — internal classification reasoning aimed at maintainers, not operators.

  • Move features/webhook-proxy.mdocself-hosting/guides/webhook-proxy.mdoc; add redirect.
  • Update nav.json (remove from Features, add to Self-Hosting Guides).
  • Trim ~190 → ~110 lines:
    • Drop ack/nack vocabulary; replace the 8-row attribution table with two bullets (proxy-side vs destination-side).
    • Drop the byte-transparency paragraphs and the plain-HTTP-behind-Envoy limitation note.
    • Drop the response-flag→code mapping table and envoy_flag/envoy_details diagnostics paragraph — implementation detail discoverable in code.
    • Replace the GCP-Pub/Sub retry math with a one-liner pointing at the queue config knobs.
  • Keep what operators actually need: env var, minimal reference Envoy, route-header snippet, tuning hint.

Test plan

  • Docs site renders the new page at /docs/outpost/self-hosting/guides/webhook-proxy
  • /docs/outpost/features/webhook-proxy redirects to the new URL
  • New page appears under Self-Hosting → Guides in the sidebar; gone from Features

🤖 Generated with Claude Code

The page was operator-configured (env var) but lived under Features.
Move it to self-hosting/guides/ alongside other operator content and
trim internal classification detail (ack/nack vocabulary, byte-
transparency reasoning, full response-flag mapping table, internal
diagnostics map, queue-retry math) that's only relevant to maintainers.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@alexbouchardd alexbouchardd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! I would add a note on webhook destination type docs however and mention the support for the forward proxy, link to this guide for self-hosted and for managed reference the config (Dashboard + Config API)

alexluong and others added 2 commits May 15, 2026 20:37
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The managed UI doesn't surface the env var name; only the Config API
uses it. Link the Config API and tie the env var to it specifically.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@alexluong
Copy link
Copy Markdown
Collaborator Author

@alexbouchardd good idea, updated!

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