Skip to content

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

Closed

Description

@nadzeyav

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?

Activity

  1. added this to the Community MVP milestone on May 27, 2022
  2. added
    siteArea: frontend dashboard
    apiArea: HTTP API
    and removed
    siteArea: frontend dashboard
    on May 31, 2022
  3. misskniss commented on May 31, 2022

    @misskniss

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

  4. misskniss commented on Jun 1, 2022

    @misskniss

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

  5. 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
  6. 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
  7. johnstcn commented on Jun 8, 2022

    @johnstcn
    Member

    #2159 covers the CLI part of this

  8. removed their assignment
    on Jun 14, 2022
  9. bpmct commented on Jul 25, 2022

    @bpmct
    Member

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

  10. oxy commented on Jul 28, 2022

    @oxy
    Contributor

    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?

  11. bpmct commented on Jul 28, 2022

    @bpmct
    Member

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

  12. oxy commented on Jul 28, 2022

    @oxy
    Contributor

    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

  13. bpmct commented on Jul 28, 2022

    @bpmct
    Member

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

  14. ketang commented on Jul 31, 2022

    @ketang
    Contributor

    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

Metadata

Metadata

Assignees

Labels

apiArea: HTTP APIsiteArea: frontend dashboard

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions