Address usability experience for azsdk verify-setup
#12976
Conversation
github-actions
bot
added
the
azsdk-cli
|
The following pipelines have been queued for testing: |
eng/common/instructions/azsdk-tools/verify-setup.instructions.md
Outdated
Show resolved
Hide resolved
Co-authored-by: jenny <[email protected]>
|
The following pipelines have been queued for testing: |
samvaity
requested review from
a team,
MrJustinB,
maririos and
praveenkuttappan
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR improves the usability of the azsdk verify-setup command by clarifying instructions and removing formatting issues. The changes focus on making error messages and setup instructions more user-friendly and actionable.
Key Changes:
- Improved clarity of Python tool installation instructions by explicitly mentioning the need to navigate to the SDK repository root
- Fixed formatting issues in instructions (removed unnecessary backticks)
- Refined Python environment variable guidance to be more concise and less demanding
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| VerifySetupResponse.cs | Added blank line for improved code formatting |
| RequirementsV1.json | Removed backticks from npm command and added repository navigation context to Python tool instructions |
| verify-setup.instructions.md | Rewrote Python environment variable guidance to be more informative and less directive |
tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json
Outdated
Show resolved
Hide resolved
tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json
Outdated
Show resolved
Hide resolved
tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json
Outdated
Show resolved
Hide resolved
tools/azsdk-cli/Azure.Sdk.Tools.Cli/Configuration/RequirementsV1.json
Outdated
Show resolved
Hide resolved
|
The following pipelines have been queued for testing: |
Closes #12927