Commit78af5e0

authored

docs: add note about incompatible immutable parameters behavior to parameters doc (#18814)

closes#18370 workspace creation page checks for1. required parameters2. incompatible immutable parametersand if there's an issue, disables the **Create workspace** button untilit's resolved[preview](https://coder.com/docs/@18370-immutable-params/admin/templates/extending-templates/parameters#mutability)---------Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>

1 parent3126f21 commit78af5e0Copy full SHA for 78af5e0

File tree

-5

lines changed

-5

lines changed

Lines changed: 4 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -207,8 +207,8 @@ data "coder_parameter" "dotfiles_url" {`
`207`	`207`	`Immutable parameters can only be set in these situations:`
`208`	`208`
`209`	`209`	`- Creating a workspace for the first time.`
`210`		`-- Updating a workspace to a new template version. This sets the initial value`
`211`		`- for required parameters.`
	`210`	`+- Updating a workspace to a new template version.`
	`211`	`+This sets the initial valuefor required parameters.`
`212`	`212`
`213`	`213`	`The idea is to prevent users from modifying fragile or persistent workspace`
`214`	`214`	`resources like volumes, regions, and so on.`
`@@ -224,9 +224,8 @@ data "coder_parameter" "region" {`
`224`	`224`	`}`
`225`	`225`	```
`226`	`226`
`227`		-You can modify a parameter's`mutable` attribute state anytime. Incase of
`228`		`-emergency, you can temporarily allowfor changing immutable parameters to fix an`
`229`		`-operational issue, but it is not advised to overuse this opportunity.`
	`227`	`+If a required parameter is empty or if the workspace creation page detects an incompatibility between selected`
	`228`	`+parameters, the Create workspace button is disabled until the issues are resolved.`
`230`	`229`
`231`	`230`	`## Ephemeral parameters`
`232`	`231`

Comments

(0)