Skip to content

Allow template parameter descriptions to be markdown #5931

Closed

Description

@mh013370

It'd be really nice, to enhance the workspace creation UI, to be able to use markdown in template parameter descriptions. This way, things like hyperlinks, headers, or anything else markdown, would be rendered nicely in the UI. Right now, it's straight text.

For example, a parameter in terraform could be enhanced like so:

variable "image" {
   type = string
   description = <<EOT
     # Select Workspace Image
     See the [registry](https://container.registry.blah/namespace) for options.
   EOT
   default = "container.registry.blah/namespace/image:tag"
}

Perhaps the description could be passed through a markdown processor? Longer term, it'd be nice to support list(string) variable types like is supported in coder v1, but that can be handled in a separate issue.

Here's the react code for parameter input.
https://github.com/coder/coder/blob/main/site/src/components/ParameterInput/ParameterInput.tsx

Activity

  1. B94715 commented on Jan 31, 2023

    @B94715

    I'm happy to look into this on Thursday (2nd of Feb), if no current contributors are wanting to be assigned to the issue.

  2. ammario commented on Jan 31, 2023

    @ammario
    Member

    This is a good idea for the parameters revamp happening here.

    @mtojek — what do you think?

  3. mh013370 commented on Feb 1, 2023

    @mh013370
    ContributorAuthor

    RichParameters seems like a nice place to include an addition like this 👍

  4. mtojek commented on Feb 1, 2023

    @mtojek
    Member

    It's a nice idea, but it isn't just enabling the Markdown renderer for description fields, but also stripping the Markdown format from the CLI tool (as we can't render Markdown there). The PR is already fairly large, so I'd rather add it as a follow-up.

    I added this issue to the roadmap.

  5. self-assigned this
    on Feb 7, 2023
  6. added this to the Rich Parameters GA milestone on Feb 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions