From 78af5e0f53cffe1b9044672f6a79e0f517e9d6f5 Mon Sep 17 00:00:00 2001 From: Edward Angert Date: Mon, 14 Jul 2025 07:43:43 -0400 Subject: [PATCH] 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> --- docs/admin/templates/extending-templates/parameters.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/admin/templates/extending-templates/parameters.md b/docs/admin/templates/extending-templates/parameters.md index d29cf8c29c..5b380645c1 100644 --- a/docs/admin/templates/extending-templates/parameters.md +++ b/docs/admin/templates/extending-templates/parameters.md @@ -207,8 +207,8 @@ data "coder_parameter" "dotfiles_url" { Immutable parameters can only be set in these situations: - Creating a workspace for the first time. -- Updating a workspace to a new template version. This sets the initial value - for required parameters. +- Updating a workspace to a new template version. + This sets the initial value for required parameters. The idea is to prevent users from modifying fragile or persistent workspace resources like volumes, regions, and so on. @@ -224,9 +224,8 @@ data "coder_parameter" "region" { } ``` -You can modify a parameter's `mutable` attribute state anytime. In case of -emergency, you can temporarily allow for changing immutable parameters to fix an -operational issue, but it is not advised to overuse this opportunity. +If a required parameter is empty or if the workspace creation page detects an incompatibility between selected +parameters, the **Create workspace** button is disabled until the issues are resolved. ## Ephemeral parameters