docs: fix broken extending-templates examples (dynamic-parameters, docker-in-workspaces) - #28100
Draft
nickvigilante wants to merge 1 commit into
Draft
Conversation
…xamples Fixes example drift found in the DOCS-637 sweep (verified against main and the CLI): - dynamic-parameters: the Dynamic Validation snippet referenced an undefined `show_cpu_cores` via a stray `count` line copied from the Hide/Show Options example, failing `terraform validate` standalone. Remove the `count` line so the snippet is self-contained and on-topic. - docker-in-workspaces: `echo "kubernetes-with-podman" | coder templates init` used a template id that is not a built-in starter, so the command never scaffolds anything. The linked template is a community template, so clone coder/community-templates and create from its kubernetes-podman directory instead. Excludes the external-auth.md dangling "See" sentence (third item in the issue): the correct link target needs a decision, handled separately. > This PR was created with AI assistance (Coder Agents).
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
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
1 participant
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
Fixes broken examples on two
extending-templatespages, surfaced by the DOCS-637 runtime drift sweep. Verified againstmain, the CLI source, and thecoder/community-templatesrepo.Changes
dynamic-parameters.mdshow_cpu_coresthrough a straycount = data.coder_parameter.show_cpu_cores.value ? 1 : 0line copied from the earlier Hide/Show Options example. Standalone copy failedterraform validate. Removed thecountline (and its misleading "Only show this parameter" comment) so the snippet is self-contained and focused on dynamic validation. The valid occurrence in the Hide/Show example (whereshow_cpu_coresis defined) is untouched.docker-in-workspaces.mdecho "kubernetes-with-podman" | coder templates initused a template id that isn't a built-in starter (templates initonly offers the embeddedexamples/templatesids:kubernetes,kubernetes-devcontainer, …), so the command never scaffolds anything. The linked template is a community template, so the block now clonescoder/community-templatesand creates from itskubernetes-podman/directory (confirmed that path exists and containsmain.tf).Held for a decision (third item in the issue, not in this PR)
external-auth.mdhas a sentence that dead-ends mid-reference. The full passage:The sentence ends at "See" with no link, then goes straight to the next heading. The right target is a content decision (candidates: the env-var / server config reference, or a dedicated external-auth configuration section), so I've left it out of this PR pending that call. Happy to add it here or in a follow-up once the target is chosen.
Linear: https://linear.app/codercom/issue/DOCS-645