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
Add a way to populate template description in CLI to allow display on UI templates screen #1839
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[/+]on Jun 7, 2022
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[/+]on Jun 7, 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
Activity
misskniss commentedon May 31, 2022
Added @oxy to assist in validation that the template descriptions shows up in the UI
misskniss commentedon Jun 1, 2022
Hey team! Please add your planning poker estimate with ZenHub @oxy @coadler
[-]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[/+][-]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[/+]johnstcn commentedon Jun 8, 2022
#2159 covers the CLI part of this
bpmct commentedon 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 commentedon Jul 28, 2022
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 commentedon Jul 28, 2022
@oxy following up on this question
oxy commentedon Jul 28, 2022
The
coder templates inithint [eg. Develop in Docker...] shows up in yaml front matter forREADME.mdin the template itself, but thedescriptionfield 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 commentedon 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 👍🏼
ketang commentedon Jul 31, 2022
@bpmct this is worth a little effort to try to simplify