Reorganize Temporal Proxy documentation - #5298
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📖 Docs PR preview links |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5ebcbcbdda
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| }, | ||
| 'production-deployment/temporal-proxy/deploy-kubernetes', | ||
| 'production-deployment/temporal-proxy/operate-troubleshoot', | ||
| 'production-deployment/temporal-proxy/reference', |
There was a problem hiding this comment.
This entry places a pure lookup page under Deploy to production: reference.mdx consists of release artifacts, command flags, configuration keys, compatibility, and metrics. readme/INFORMATION-ARCHITECTURE.md defines this section as how-tos and explanations while assigning command, configuration, and metrics reference material to References, so move this page—or split its reference material—under /references and link to it from the Proxy section.
AGENTS.md reference: AGENTS.md:L246-L250
Useful? React with 👍 / 👎.
| ## Resolve startup failures | ||
|
|
||
| The proxy validates its configuration before accepting gateway traffic. Configuration errors include the YAML path of | ||
| the invalid field when possible. Check these causes first: |
There was a problem hiding this comment.
This catch-all troubleshooting section combines invalid configuration, certificate errors, unavailable upstreams, port conflicts, and KMS failures, followed by another table covering unrelated request failures. readme/INFORMATION-ARCHITECTURE.md requires troubleshooting pages to target one specific error or operational problem, so keep monitoring and routine operations here and move the concrete failure cases into focused pages under docs/troubleshooting/.
AGENTS.md reference: AGENTS.md:L248-L252
Useful? React with 👍 / 👎.
1 participant
Summary
Why
The existing section mixes evaluation guidance, configuration, encryption-key operations, troubleshooting, and reference material on a few long pages. This structure makes critical deployment decisions—especially proxy bypass, security boundaries, availability, and key retirement—harder to find and evaluate.
Validation
vale --config .vale-ci.ini docs/production-deployment/temporal-proxyyarn lint:mermaidyarn check:orphansyarn buildgit diff --cached --checkPR stack
This PR is stacked on #5293, which adds the fail-closed clarification incorporated into the reorganized encryption page. Existing Proxy document IDs and slugs are preserved, so this change does not require redirects.