You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/DeploymentGuide.md
+25-24Lines changed: 25 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ Select one of the following options to deploy the Document Generation Solution A
116
116
<details>
117
117
<summary><b>Option C: Visual Studio Code Web</b></summary>
118
118
119
-
[&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==)
119
+
[&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9tYWluL2luZnJhL3ZzY29kZV93ZWIiLCAiaW5kZXhVcmwiOiAiL2luZGV4Lmpzb24iLCAidmFyaWFibGVzIjogeyJhZ2VudElkIjogIiIsICJjb25uZWN0aW9uU3RyaW5nIjogIiIsICJ0aHJlYWRJZCI6ICIiLCAidXNlck1lc3NhZ2UiOiAiIiwgInBsYXlncm91bmROYW1lIjogIiIsICJsb2NhdGlvbiI6ICIiLCAic3Vic2NyaXB0aW9uSWQiOiAiIiwgInJlc291cmNlSWQiOiAiIiwgInByb2plY3RSZXNvdXJjZUlkIjogIiIsICJlbmRwb2ludCI6ICIifSwgImNvZGVSb3V0ZSI6IFsiYWktcHJvamVjdHMtc2RrIiwgInB5dGhvbiIsICJkZWZhdWx0LWF6dXJlLWF1dGgiLCAiZW5kcG9pbnQiXX0=)
120
120
121
121
1. Click the badge above (may take a few minutes to load)
122
122
2. Sign in with your Azure account when prompted
@@ -240,6 +240,8 @@ To optimize costs and integrate with your existing Azure infrastructure, you can
240
240
241
241
💡 **Before You Start:** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for common solutions.
242
242
243
+
⚠️ **Critical: Redeployment Warning:** If you have previously run `azd up` in this folder (i.e., a `.azure` folder exists), you must [create a fresh environment](#creating-a-new-environment) to avoid conflicts and deployment failures.
244
+
243
245
### 4.1 Authenticate with Azure
244
246
245
247
```shell
@@ -325,6 +327,26 @@ If deployment fails or you need to clean up manually:
325
327
- Follow [Delete Resource Group Guide](./DeleteResourceGroup.md)
326
328
- See section below for "Deleting Resources After a Failed Deployment"
327
329
330
+
## Local Development & Debugging
331
+
332
+
After deploying the solution to Azure, you can run and debug the application locally by connecting to your deployed Azure resources.
333
+
334
+
### Configure Environment Variables
335
+
336
+
1. Create a `.env` file in the `src` directory of your project
337
+
2. Set the `APP_ENV` variable to match your deployed environment name:
338
+
```
339
+
APP_ENV=<your-environment-name>
340
+
```
341
+
3. Authenticate with Azure CLI to access deployed resources:
342
+
```shell
343
+
az login
344
+
```
345
+
346
+
The application will use the Azure CLI credentials to connect to the deployed Azure resources (Azure AI Search, Cosmos DB, etc.) using the environment name specified in `APP_ENV`.
347
+
348
+
For complete local development setup instructions, see the [Local Development Setup Guide](./LocalDevelopmentSetup.md).
349
+
328
350
## 🛠️ Troubleshooting
329
351
330
352
If you encounter issues during deployment, see our comprehensive [Troubleshooting Guide](./TroubleShootingSteps.md) for solutions to common problems.
@@ -429,9 +451,10 @@ azd env get-values
429
451
430
452
Now that your deployment is complete and tested, explore these resources to enhance your experience:
431
453
432
-
� **Get Started:**
454
+
🚀 **Get Started:**
433
455
434
456
- [Sample Questions](./SampleQuestions.md) - Try these sample questions to explore the solution's capabilities
457
+
- Test the application with your own documents and queries
435
458
436
459
🔧 **Development & Customization:**
437
460
@@ -449,28 +472,6 @@ Now that your deployment is complete and tested, explore these resources to enha
- 🔧 **Development:** See [Contributing Guide](../CONTRIBUTING.md)
451
474
452
-
---
453
-
454
-
## Environment configuration for local development & debugging
455
-
456
-
To run and debug the application locally, you need to configure environment variables in a `.env` file:
457
-
458
-
1. Create a `.env` file in the `src` directory of your project
459
-
2. Set the `APP_ENV` variable to match your deployed environment name:
460
-
```
461
-
APP_ENV=<your-environment-name>
462
-
```
463
-
3. Authenticate with Azure CLI to access deployed resources:
464
-
```shell
465
-
az login
466
-
```
467
-
468
-
The application will use the Azure CLI credentials to connect to the deployed Azure resources (Azure AI Search, Cosmos DB, etc.) using the environment name specified in `APP_ENV`.
469
-
470
-
For complete local development setup instructions, see the [Local Development Setup Guide](./LocalDevelopmentSetup.md).
471
-
472
-
---
473
-
474
475
## Advanced: Deploy Local Changes
475
476
476
477
If you've made local modifications to the code and want to deploy them to Azure, follow these steps to swap the configuration files:
0 commit comments