Repository navigation
🤖 docs: scope the namespace deletion step and list the exact uncertain-create cases - #247
Conversation
…n-create cases (Refs #215) Change-Id: Ie0a71a2e43293a1d68a0975580bab774b4cf89b5 Signed-off-by: Thomas Kosiewski <tk@coder.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
@codex review |
|
@codex security review |
![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: 9282f11d72
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…answers Change-Id: I11eda3af7617f8b5a7d15082a16f8ace421708fc Signed-off-by: Thomas Kosiewski <tk@coder.com>
|
@codex review |
|
@codex security review |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
|
Codex Review: Didn't find any major issues. 🚀 Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
1 participant
Summary
Two docs fixes. First, the two nits recorded in #215 (comment) for the troubleshooting step "A namespace stays
Terminating". Second, a correction from the final assessment of #241: the "Coder timeouts" text claimed more504coverage for broken2xxcreate answers than the code gives.Refs #215
Changes
docs/how-to/troubleshooting.md, "A namespace staysTerminating", step 2:NamespaceDeletionContentFailurewhen any API fails during the deletion. The step now applies the aggregated-API guidance only if the message namesaggregation.coder.com, and otherwise says to examine the API that the message names (review thread r4174236818 on 🤖 docs: update the Terminating namespace step after the #209 fix #219).400that saysmultiple eligible CoderControlPlane instancesnow links the existing troubleshooting entry for it (thread r4174236822).multiple eligible CoderControlPlane ..." to "Aggregated reads returnmultiple eligible CoderControlPlane instances". With the trailing..., markdownlint (MD051, GitHub slugs) needs a fragment that ends in-, and MkDocs makes the anchor without it, so no link could satisfy both. The new heading matches the server message (internal/aggregated/coder/controlplane_provider.go:326,330). No page linked the old anchor.docs/reference/aggregated-api-behavior.md, "Coder timeouts" and its summary row: the text said that a create returns504for any2xxanswer that "is not the answer that Coder sends", and its list of500cases looked complete. It now lists exactly which broken2xxanswers give the uncertain504, gives examples of answers that give500(including a201with{}, tracked in 🤖 Aggregated writes: map other uncertain Coder answers (502/503, broken body read) to the uncertain 504 #242), and tells the client to re-read after either. The summary row now says "504or500" instead of "Most ...".Validation
The new list in (2) is checked against the vendored SDK paths.
CreateUserWorkspaceandCreateTemplatesend any status other than201toReadBodyAsError, and a201toReadBodyAsJSON(vendor/github.com/coder/coder/v2/codersdk/organizations.go:553-558,678-683,client.go:421-453,538-571). A throwaway test (not committed) put a proxy in front of the mock Coder and sent each answer to a workspace create:201: HTML page, empty body, invalid JSON (with and withoutapplication/json)504uncertain200or202with Coder's JSON,204empty,200HTML,200empty or{}JSON,200text/plaininvalid JSON504uncertain200application/jsoninvalid JSON500(decode body)201with{}ornull500throughWithPanicRecovery201or200whose body breaks off500(unexpected EOF)Also run:
make docs-check(strict MkDocs build; the built page hasid="aggregated-reads-return-multiple-eligible-codercontrolplane-instances"), the CI versions ofmarkdownlint-cli2(0.18.1) andcspell(8.19.4) ondocs/**/*.md,make verify-vendor,make test,make buildandmake lint.Not in this PR
#215 item 2 (an unconfigured standalone server returns
503on namespaced LIST, so namespace deletion hangs) is a product decision and stays open.Generated with
mux• Model:anthropic:claude-opus-5-5• Thinking:high