-
Notifications
You must be signed in to change notification settings - Fork 881
feat: add template description #1489
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about lowering the length to something like 128? I was thinking we'd display this in the table view for templates, coder templates ls
, and ideally in the CLI when a user is selecting a template to create a workspace.
I want us to add parsing of a README.md to template versions. Then we can display markdown of the latest build in a template page, and make it really slick!
Aha, that makes more sense. I was thinking you'd put the big markdown in the template, but I think that actually makes more sense on the template version like you said! I'll update that now. |
Yeah, it'd be nice to source-control it just like you would template stuff. It'd be cool to view the markdown in GitHub just like you could in our UI. |
site/src/api/typesGenerated.ts
Outdated
@@ -62,6 +62,7 @@ export interface CreateParameterRequest { | |||
// From codersdk/organizations.go:38:6 | |||
export interface CreateTemplateRequest { | |||
readonly name: string | |||
readonly description: string |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is description
required?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is not
@@ -219,6 +220,7 @@ export interface Template { | |||
readonly provisioner: string | |||
readonly active_version_id: string | |||
readonly workspace_owner_count: number | |||
readonly description: string |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Here too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The backend will always return a description, but it can be an empty string.
Resolves #206