Skip to content

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

Merged
merged 6 commits into from
May 16, 2022
Merged

feat: add template description #1489

merged 6 commits into from
May 16, 2022

Conversation

coadler
Copy link
Contributor

@coadler coadler commented May 16, 2022

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
Copy link
Member

@kylecarbs kylecarbs left a 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!

@coadler
Copy link
Contributor Author

coadler commented May 16, 2022

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
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.

@@ -62,6 +62,7 @@ export interface CreateParameterRequest {
// From codersdk/organizations.go:38:6
export interface CreateTemplateRequest {
readonly name: string
readonly description: string
Copy link
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
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

@@ -219,6 +220,7 @@ export interface Template {
readonly provisioner: string
readonly active_version_id: string
readonly workspace_owner_count: number
readonly description: string
Copy link
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
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
kylecarbs pushed a commit that referenced this pull request Jun 10, 2022
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