You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Allow template parameter descriptions to be markdown #5931
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=stringdescription=<<EOT # Select Workspace Image See the [registry](https://container.registry.blah/namespace) for options. EOTdefault="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.
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.
Activity
B94715 commentedon Jan 31, 2023
I'm happy to look into this on Thursday (2nd of Feb), if no current contributors are wanting to be assigned to the issue.
ammario commentedon Jan 31, 2023
This is a good idea for the parameters revamp happening here.
@mtojek — what do you think?
mh013370 commentedon Feb 1, 2023
RichParametersseems like a nice place to include an addition like this 👍mtojek commentedon Feb 1, 2023
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.