docs: Update Deployment Guide with Azure authentication steps #90
Conversation
Added instructions for authenticating with Azure in VS Code Web.
Thanusree-Microsoft
requested review from
Avijit-Microsoft,
Dongbumlee,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
dgp10801,
nchandhi,
sethsteenken and
toherman-msft
as code owners
There was a problem hiding this comment.
Pull request overview
This PR updates the Deployment Guide to add Azure authentication instructions specifically for the VS Code Web deployment option. The documentation now includes device code authentication steps to address authentication issues users may encounter in the VS Code Web environment.
Key Changes
- Added explicit Azure CLI authentication step using device code flow (
az login --use-device-code) - Reorganized instruction text for better clarity
- Added a note explaining why device code authentication is required in VS Code Web environments
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| sh install.sh | ||
| ``` | ||
| During this process, you’ll be prompted with the message: | ||
| <br> Choose “**Overwrite with versions from template**” and provide a unique environment name when prompted. |
There was a problem hiding this comment.
The indentation is inconsistent here. This line uses 3 spaces for indentation while the surrounding lines use 4 spaces. This should be adjusted to maintain consistent formatting with the rest of the code block.
| <br> Choose “**Overwrite with versions from template**” and provide a unique environment name when prompted. | |
| <br> Choose “**Overwrite with versions from template**” and provide a unique environment name when prompted. |
| ``` | ||
| Choose “**Overwrite with versions from template**” and provide a unique environment name when prompted. | ||
| 6. Proceed to [Step 3: Configure Deployment Settings](#step-3-configure-deployment-settings) | ||
| 7. **Authenticate with Azure** (VS Code Web requires device code authentication): |
There was a problem hiding this comment.
The step numbering is inconsistent. The sequence goes from step 5 (line 131) to step 7 (this line), skipping step 6. This should be renumbered as step 6 to maintain sequential ordering.
| 7. **Authenticate with Azure** (VS Code Web requires device code authentication): | |
| 6. **Authenticate with Azure** (VS Code Web requires device code authentication): |
| az login --use-device-code | ||
| ``` | ||
| > **Note:** In VS Code Web environment, the regular `az login` command may fail. Use the `--use-device-code` flag to authenticate via device code flow. Follow the prompts in the terminal to complete authentication. | ||
| 8. Proceed to [Step 3: Configure Deployment Settings](#step-3-configure-deployment-settings) |
There was a problem hiding this comment.
The step numbering is inconsistent. This should be step 7 instead of step 8, following the renumbering of the previous authentication step.
| 8. Proceed to [Step 3: Configure Deployment Settings](#step-3-configure-deployment-settings) | |
| 7. Proceed to [Step 3: Configure Deployment Settings](#step-3-configure-deployment-settings) |
| <details> | ||
| <summary><b>Option C: Visual Studio Code Web</b></summary> | ||
|
|
||
| ### VS Code Web |
There was a problem hiding this comment.
This heading appears redundant since the parent collapsible section is already titled "Option C: Visual Studio Code Web". Consider removing this heading or renaming it to something more specific like "Steps" to avoid duplication.
| ### VS Code Web | |
| ### Steps |
Purpose
Updated Deployment Guide
Does this introduce a breaking change?
Other Information
Added instructions for authenticating with Azure in VS Code Web.