docs: fix prebuilt-workspaces example syntax and defaults - #28088
Draft
nickvigilante wants to merge 1 commit into
Draft
docs: fix prebuilt-workspaces example syntax and defaults#28088nickvigilante wants to merge 1 commit into
nickvigilante wants to merge 1 commit into
Conversation
coder_workspace_preset.parameters is a map(string) attribute, so it needs 'parameters = {}' not the block form 'parameters {}' (matches every other preset example in the docs and passes terraform validate). CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVAL defaults to 1m0s, not 15 seconds, per the generated server reference. 'coder provisioner jobs list' emits table output by default, so add '--output json' before piping to jq in the two cancel snippets. Fixes DOCS-644.
> 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.
What
Three fixes to
docs/admin/templates/extending-templates/prebuilt-workspaces.mdsurfaced by the runtime drift sweep.parameters { ... }is block syntax, butcoder_workspace_preset.parametersis amap(string)attribute. Changed toparameters = { ... }, which matches every othercoder_workspace_presetexample in the docs and passesterraform validate.CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVALis documented as "15 seconds"; the actual default is1m0sper the generated server reference (docs/reference/cli/server.md).jqon table output (lines 329, 341):coder provisioner jobs listemits table output by default, sojq -r '.[].id'fails to parse. Added--output jsonbefore the pipe in both cancel snippets.All verified against
main(repo preset examples,helm/CLI references).Linear: DOCS-644