Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngert EdwardAngert commented Jul 9, 2025

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

@EdwardAngert EdwardAngert self-assigned this Jul 9, 2025
@EdwardAngert EdwardAngert added the docs Area: coder.com/docs label Jul 9, 2025
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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it might make sense to add something like this to the Required and optional parameters section above this one

Copy link
Member

@Emyrk Emyrk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is good language to add 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add "incompatible immutable parameters" note to parameters doc
2 participants