Skip to content

feat: add template description - #1489

Merged
coadler merged 6 commits into
mainfrom
colin/template-desc
May 16, 2022
Merged

coadler merged 6 commits into
mainfrom
colin/template-desc

Conversation

@coadler

@coadler coadler commented May 16, 2022 •

Copy link
Copy Markdown
Contributor

Resolves #206

@coadler
coadler requested a review from a team as a code owner May 16, 2022 20:16
@coadler coadler self-assigned this May 16, 2022

@kylecarbs kylecarbs left a comment

Copy link
Copy Markdown
Member

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!

@coadler

coadler commented May 16, 2022

Copy link
Copy Markdown
Contributor Author

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.

@kylecarbs

Copy link
Copy Markdown
Member

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.

Comment thread site/src/api/typesGenerated.ts Outdated
// From codersdk/organizations.go:38:6
export interface CreateTemplateRequest {
readonly name: string
readonly description: string

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is description required?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It is not

readonly provisioner: string
readonly active_version_id: string
readonly workspace_owner_count: number
readonly description: string

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! Here too?

Copy link
Copy Markdown
Contributor Author

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.

@coadler
coadler enabled auto-merge (squash) May 16, 2022 20:53
@coadler
coadler merged commit e925818 into main May 16, 2022
@coadler
coadler deleted the colin/template-desc branch May 16, 2022 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Description field support for templates

3 participants