Skip to content

Add a way to populate template description in CLI to allow display on UI templates screen #1839

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

Closed
nadzeyav opened this issue May 27, 2022 · 9 comments
Assignees
Labels
api Area: HTTP API site Area: frontend dashboard
Milestone

Comments

@nadzeyav
Copy link

nadzeyav commented May 27, 2022

Problem

There is a template description field supported via API.
but there is no way for how to populate it (or it is not obvious, no CLI or UI is available).

Definition of Done

The property is added to API and mentioned that should be avaialble to be set through CLI, but there is no such option

image

Implementation Notes:
This is read only in the frontend.

Why do you want this feature?

Are there any workarounds to get this functionality today?

Are you interested in submitting a PR for this?

@tjcran tjcran added this to the Community MVP milestone May 27, 2022
@misskniss misskniss added site Area: frontend dashboard api Area: HTTP API and removed site Area: frontend dashboard labels May 31, 2022
@misskniss
Copy link

Added @oxy to assist in validation that the template descriptions shows up in the UI

@misskniss
Copy link

Hey team! Please add your planning poker estimate with ZenHub @oxy @coadler

@kylecarbs kylecarbs changed the title Feat: Add a way to populate template description, that is displayed on UI templates screen Add a way to populate template description, that is displayed on UI templates screen Jun 7, 2022
@misskniss misskniss changed the title Add a way to populate template description, that is displayed on UI templates screen Add a way to populate template description in CLI to allow display on UI templates screen Jun 7, 2022
@johnstcn
Copy link
Member

johnstcn commented Jun 8, 2022

#2159 covers the CLI part of this

@coadler coadler removed their assignment Jun 14, 2022
@misskniss misskniss added the site Area: frontend dashboard label Jun 21, 2022
@misskniss misskniss mentioned this issue Jul 19, 2022
20 tasks
@bpmct
Copy link
Member

bpmct commented Jul 25, 2022

How does this compare to the description parsed in the README and that displays in coder templates init?

IMO, I prefer using markdown for metadata like this, or perhaps #2987 down the road..

@oxy
Copy link
Contributor

oxy commented Jul 28, 2022

image
Template descriptions [when set] do already show!

Copy was edited in #2247 to remove the "no description" text: eab5c15#diff-943704768957dc526907e01c9a3798d7804c3c560704712c2ae8d05dd90a953b

Can we close the issue as done?

@bpmct
Copy link
Member

bpmct commented Jul 28, 2022

@oxy following up on this question

How does this compare to the description parsed in the README and that displays in coder templates init?

IMO, I prefer using markdown for metadata like this, or perhaps #2987 down the road..

@oxy
Copy link
Contributor

oxy commented Jul 28, 2022

The coder templates init hint [eg. Develop in Docker...] shows up in yaml front matter for README.md in the template itself, but the description field returned by the server is a metadata tag that the server stores separately [and is initialized separately by the CLI] (see #2159)

I'm not sure if you're suggesting that we use the front matter for the description; and if so, if we should make the CLI responsible for parsing front matter and then sending that as the description tag, or if we want to approach this another way

@bpmct
Copy link
Member

bpmct commented Jul 28, 2022

I'm personally confused that there are 2 different descriptions for a template, but I think you're right this can be considered done 👍🏼

@bpmct bpmct closed this as completed Jul 28, 2022
@ketang
Copy link
Contributor

ketang commented Jul 31, 2022

I'm personally confused that there are 2 different descriptions for a template

@bpmct this is worth a little effort to try to simplify

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Area: HTTP API site Area: frontend dashboard
Projects
None yet
Development

No branches or pull requests

10 participants