Skip to content

Commit 78af5e0

Browse files
authored
docs: add note about incompatible immutable parameters behavior to parameters doc (#18814)
closes #18370 workspace creation page checks for 1. required parameters 2. incompatible immutable parameters and if there's an issue, disables the **Create workspace** button until it'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 parent 3126f21 commit 78af5e0

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/admin/templates/extending-templates/parameters.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,8 @@ data "coder_parameter" "dotfiles_url" {
207207
Immutable parameters can only be set in these situations:
208208
209209
- 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 value for required parameters.
212212
213213
The idea is to prevent users from modifying fragile or persistent workspace
214214
resources like volumes, regions, and so on.
@@ -224,9 +224,8 @@ data "coder_parameter" "region" {
224224
}
225225
```
226226
227-
You can modify a parameter's `mutable` attribute state anytime. In case of
228-
emergency, you can temporarily allow for 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.
230229
231230
## Ephemeral parameters
232231

0 commit comments

Comments
 (0)