Template discoverability improvements (azd template list, azd init, azd template show)

[Austinauth]

Issue description

There are substantial issues and opportunities for improvement for the azd template list, azd template show and azd init experiences. This issue tracks a workstream focused on improving the aforementioned commands.

Examples

A detailed write up on pain points, open questions and more can be found in this Figjam.

azd template list

azd template show

azd init

[Austinauth]

@wbreza, @rajeshkamal5050 mentioned you might be able to help with this issue over the following weeks.

I aim to have some concepts designed by the end of next week. There will likely be a few versions of each command for which we will want to create coded prototypes. I understand that you likely have other ongoing issues that take priority over this one, so I am happy to sync one-on-one to discuss a roadmap that works for you.

For what it's worth, we discussed open questions, pain points, and ideas related to each command during this week's demo call. If you have a spare moment, it might be worth catching the recording. I would love to hear if you have any ideas or pain points you've observed.

[TWolversonReply]

I have noticed some strange behaviour using a custom template source, in this case, from a file. I'm specifying private repositories which I have access to, and their Name and Repository Path come up blank from azd template list, but azd init specifying repo-owner/repo-name works fine.

[Austinauth]

Rough Explorations

At the risk of perfect being the enemy of good, here are a couple of approaches for which I think we should create coded prototypes for @wbreza (time permitting). Ideally, we will be able to use the coded prototypes to solicit feedback from others internally and determine whether the interactions are effective or not.

These are all quick sketches, you may have make assumptions about interactivity until we're able to regroup and discuss.

cc: @kristenwomack, @vhvb1989

azd template list

Static Options (No interactivity)

• We will likely have to tinker with the truncation.
• Should behave similar to the gh pr list command.

Truncated Table (3 Column)

Truncated Table (2 Column)

Static List (No Interactivity)

• A long scrolling list, rather than a table
• Accommodates more metadata at the expense of vertical scrolling

Interactive Options

Need a bit more time to finalize these concepts, but feel free to begin prototyping if you're comfortable.

Interactive table

• Behaves similar to a list select
• Scroll up and down a list of templates
• Type to filter
• Enter to select a template and see additional details (azd template show)

Interactive list

• Behaves the same as the interactive table, but in list format
• The template details should reflect the details of the highlighted template
• Enter to select a template and see additional details (azd template show)

---

Time permitting, I will do my best to finalize the concepts and create interactive prototypes. Until then, feel free to expirment with the sketches above.

[SophCarp]

Notes from July 2024 experience audit