[azsdkcli] add next steps#11747
Conversation
github-actions
Bot
added
the
azsdk-cli
praveenkuttappan
left a comment
praveenkuttappan
left a comment
There was a problem hiding this comment.
Looks fine to me except a nit suggestion about NEXT STEPS output.
l0lawrence
requested review from
jeo02,
maririos,
richardpark-msft,
samvaity,
scbedd,
smw-ms and
timovv
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for displaying next steps in the Azure SDK CLI response model. The primary purpose is to provide users with actionable guidance after receiving responses from CLI operations.
- Adds a new
NextStepsproperty to the Response class for storing next steps information - Updates the ToString method to display next steps alongside error messages
- Refactors the ToString method to use a more generic "messages" variable instead of "errors" to accommodate both error and next steps content
timovv
left a comment
timovv
left a comment
There was a problem hiding this comment.
Looks good to me, I think this idea of having actionable steps to take is a good one and will help people through the process
|
Understanding the flow: does this means that each tool will be responsible for managing the next steps? |
richardpark-msft
left a comment
richardpark-msft
left a comment
There was a problem hiding this comment.
We need to start adding in XML doc comments for these things, especially fields that are just wide open with what gets put into them.
"What's the expected output when I fill this in, and why should I use it?"
|
I'm approving, but @samvaity's comments point to us wanting to have some more workable examples to look at. Given the examples from the other chat, it looks like this is primarily about enhancing error messages, or (sometimes) trying to get the user to a next step that has docs and (probably) stuff they need to read. From talking with @l0lawrence, I think the main goal is that we blanket the user with all the info they need to get from one step to another, and stuff like this can keep them in the chat session (if that's where they started), or the CLI, if they work there. |
* next steps * next step as string * next step update * documentation * this
* next steps * next step as string * next step update * documentation * this
No description provided.