Skip to content

Commit 4e65c3f

Browse files
updated deployement readme
1 parent df86a6a commit 4e65c3f

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

docs/DeploymentGuide.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ Select one of the following options to deploy the Document Generation Solution A
7575

7676
| **Option** | **Best For** | **Prerequisites** | **Setup Time** |
7777
|------------|--------------|-------------------|----------------|
78-
| **GitHub Codespaces** | Quick deployment, no local setup required | GitHub account | ~3-5 minutes |
79-
| **VS Code Dev Containers** | Fast deployment with local tools | Docker Desktop, VS Code | ~5-10 minutes |
80-
| **VS Code Web** | Quick deployment, no local setup required | Azure account | ~2-4 minutes |
81-
| **Local Environment** | Enterprise environments, full control | All tools individually | ~15-30 minutes |
78+
| **GitHub Codespaces** | Quick deployment, no local setup required | GitHub account | ~5-7 minutes |
79+
| **VS Code Dev Containers** | Fast deployment with local tools | Docker Desktop, VS Code | ~6-10 minutes |
80+
| **VS Code Web** | Quick deployment, no local setup required | Azure account | ~6-8 minutes |
81+
| **Local Environment** | Enterprise environments, full control | All tools individually | ~7-10 minutes |
8282

8383
**💡 Recommendation:** For fastest deployment, start with **GitHub Codespaces** - no local installation required.
8484

@@ -256,11 +256,11 @@ azd up
256256
**During deployment, you'll be prompted for:**
257257
1. **Environment name** (e.g., "docgen") - Must be 3-16 characters long, alphanumeric only
258258
2. **Azure subscription** selection
259-
3. **Azure AI Foundry deployment region** - Select a region with available o3 model quota for AI operations
259+
3. **Azure AI Foundry deployment region** - Select a region with available OpenAI model quota for AI operations
260260
4. **Primary location** - Select the region where your infrastructure resources will be deployed
261261
5. **Resource group** selection (create new or use existing)
262262

263-
**Expected Duration:** 4-6 minutes for default configuration
263+
**Expected Duration:** 6-8 minutes for default configuration
264264

265265
**⚠️ Deployment Issues:** If you encounter errors or timeouts, try a different region as there may be capacity constraints. For detailed error solutions, see our [Troubleshooting Guide](./TroubleShootingSteps.md).
266266

@@ -269,7 +269,7 @@ azd up
269269
After successful deployment:
270270
1. Open [Azure Portal](https://portal.azure.com/)
271271
2. Navigate to your resource group
272-
3. Find the Container App with "frontend" in the name
272+
3. Find the App Service with "app" in the name
273273
4. Copy the **Application URI**
274274

275275
⚠️ **Important:** Complete [Post-Deployment Steps](#step-5-post-deployment-configuration) before accessing the application.
@@ -278,7 +278,7 @@ After successful deployment:
278278

279279
### 5.1 Sample Data Import
280280

281-
1. Once the deployment has completed successfully and you would like to use the sample data, please open a **Git Bash** terminal and run the bash command printed below. The bash command will look like the following:
281+
Once the deployment has completed successfully and you would like to use the sample data, please open a **Git Bash** terminal and run the bash command printed below. The bash command will look like the following:
282282
```shell
283283
bash ./infra/scripts/process_sample_data.sh
284284
```
@@ -287,8 +287,6 @@ After successful deployment:
287287
bash ./infra/scripts/process_sample_data.sh <Storage-Account-Name> <Storage-Container-Name> <Key-Vault-Name> <CosmosDB-Account-Name> <Resource-Group-Name> <Search-Service-Name> <Managed-Identity-Client-ID> <AI-Foundry-Resource-ID>
288288
```
289289

290-
2. Open the [Azure Portal](https://portal.azure.com/), go to the deployed resource group, find the App Service and get the app URL from `Default domain`.
291-
292290
### 5.2 Configure Authentication (Optional)
293291

294292
1. Follow [App Authentication Configuration](./ConfigureAppAuthentication.md)
@@ -334,7 +332,7 @@ If your deployment failed or encountered errors, here are the steps to recover:
334332
azd down
335333

336334
# Create new environment (3-16 chars, alphanumeric only)
337-
azd env new conmigretry
335+
azd env new docgenretry
338336

339337
# Deploy with different settings/region
340338
azd up
@@ -364,10 +362,10 @@ azd up
364362
**Example:**
365363
```shell
366364
# Create a new environment for production (valid: 3-16 chars)
367-
azd env new conmigprod
365+
azd env new docgenprod
368366

369367
# Switch to the new environment
370-
azd env select conmigprod
368+
azd env select docgenprod
371369

372370
# Deploy with fresh settings
373371
azd up
@@ -376,7 +374,7 @@ azd up
376374
> **Environment Name Requirements:**
377375
> - **Length:** 3-16 characters
378376
> - **Characters:** Alphanumeric only (letters and numbers)
379-
> - **Valid examples:** `conmig`, `test123`, `myappdev`, `prod2024`
377+
> - **Valid examples:** `docgen`, `test123`, `myappdev`, `prod2024`
380378
> - **Invalid examples:** `co` (too short), `my-very-long-environment-name` (too long), `test_env` (underscore not allowed), `myapp-dev` (hyphen not allowed)
381379
382380
</details>

0 commit comments

Comments
 (0)