dynamic parameters: text-only parameter

[stirby]

May already be documented.

Need a parameter that has no form control, just a markdown description.

[stirby]

A workaround is using "disabled": true on a form_type = "textarea" parameter.

However, this will not support markdown formatting.

This will help customers educate users when creating workspaces without linking to external documentation.

[Emyrk]

We should 100% have this and have no form value input rendering. Just the title + description.

Naming is... hard. The form_type value should be...

• note
• none : This make sense if form_type describes the input rendering type. But does not document it's usage/purpose.
• callout : Notion and other doc platforms have these. Maybe their formatting already has too much of an opinion.
• info : Feels kinda vague
• readonly : Technically correct?
• empty : Also technically correct?
• helptext

Example:

data "coder_parameter" "env_summary" {
  name        = "Included Tools"
  description = <<EOT
| Tool         | Version | Notes                          |
|--------------|---------|--------------------------------|
| Go           | 1.22    | Pre-installed with modules     |
| Docker       | 24.x    | Docker CLI + rootless engine   |
| PostgreSQL   | 15      | Local dev only, not production |
EOT

  form_type   = "note"
}

Future enhancement, but to consider when naming

ChatGPT also had an idea that was interesting. Notes (I guess all params) could have a tone for warning/error type callouts.

styling = jsonencode({
    tone = "info" // or "warning", "success", etc.
  })

[stirby]

Naming is always tough, good suggestions.

• note: short, simple, not super descriptive though(?)
• none: having this behave differently than not declaring form_type feels strange in writing.
• callout: I recognize this from our tools but it may be a weird one to remember
• info: Matches the use case though!
• readonly: I don't think this is correct because there would be no form control at all. Not a read-only form control
• empty: I have a gut feeling that we're going to want this later.
• helptext: is a lot to type

I like note and info a lot.

• markdown: Helps remind users that the description renders markdown and shows the power of an instructional parameter

Here are some terrible ideas that have crossed my mind

• description: Just use the description
• nocontrol: No controls are going to be rendered