Repository navigation
🤖 docs: rewrite the aggregated API server guide in plain English - #168
Merged
Merged
Conversation
Rewrite "Deploy the aggregated API server" in plain English based on ASD-STE100. Code blocks and headings are unchanged. Signed-off-by: Thomas Kosiewski <tk@coder.com> --- _Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-opus-5-5` • Thinking: `high`_ Change-Id: If8a6ad19218321222093fe2d808b7b7822119dbd
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. |
Member
Author
|
@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. |
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
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
Rewrite
docs/how-to/deploy-aggregated-apiserver.mdin plain English. The text follows ASD-STE100 (Simplified Technical English) about 80% of the time: short sentences, active voice, simple tenses, conditions before commands, and lists instead of long joined sentences. Kubernetes terms, RBAC names, commands, and code stay as they were.This is the fourth PR of a plain-English docs series (#164, #165, #166). It stands alone and is based on
main.Background
This page carries the security rules of the aggregated API server: delegated authentication, RBAC that is owner access in Coder, who can read the serving CA key, and how the server manages the APIService
caBundle. Many of these rules sit in long sentences with semicolons and parentheses. One fact per sentence makes the rules easier to check and to translate.Implementation
main(checked with a script). Anchors that other pages use (#how-callers-are-checked,#replace-the-ca,#opt-out,#how-kube-apiserver-trusts-the-server,#option-a-all-in-one-recommended,#option-b-standalone) still work.deploy/apiserver-apiservice.yamlis now its own paragraph.Validation
make docs-check(strict mkdocs build),markdownlint-cli20.18.1,cspell8.19.4, andlycheepass on the pushed commit.Before:
After:
Refs: no issue. Part of a plain-English docs pass.
Generated with
xum• Model:anthropic:claude-opus-5-5• Thinking:high