Skip to content

Commit a628a23

Browse files
Update Deployment Guide to clarify VS Code Dev Containers and streamline deployment settings
1 parent 14b58a5 commit a628a23

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

docs/DeploymentGuide.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ You can run this solution using [GitHub Codespaces](https://docs.github.com/en/c
6262
</details>
6363

6464
<details>
65-
<summary><b>Deploy in VS Code</b></summary>
65+
<summary><b>Deploy in VS Code Dev Containers</b></summary>
6666

6767
### VS Code Dev Containers
6868

@@ -110,22 +110,7 @@ Consider the following settings during your deployment to modify specific settin
110110
<details>
111111
<summary><b>Configurable Deployment Settings</b></summary>
112112

113-
When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md):
114-
115-
| **Setting** | **Description** | **Default Value** |
116-
| ------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------- |
117-
| **Azure Region** | The region where resources will be created. | East US |
118-
| **Azure AI Content Understanding Location** | Location for the **Content Understanding** service. | Sweden Central |
119-
| **Secondary Location** | A **less busy** region for **Azure Cosmos DB**, useful in case of availability constraints. | eastus2 |
120-
| **Deployment Type** | Select from a drop-down list. | GlobalStandard |
121-
| **GPT Model** | Choose from **gpt-4o**. | gpt-4o |
122-
| **GPT Model Version** | GPT model version used in the deployment. | 2024-08-06 |
123-
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. | 30k |
124-
| **Use Local Build** | Boolean flag to determine if local container builds should be used. | false |
125-
| **Image Tag** | Image version for deployment (allowed values: `latest`, `dev`, `hotfix`). | latest |
126-
| **Existing Log Analytics Workspace** | To reuse an existing Log Analytics Workspace ID instead of creating a new one. | *(none)* |
127-
| **Existing Azure AI Foundry Project** | To reuse an existing Azure AI Foundry Project ID instead of creating a new one. | *(none)* |
128-
113+
When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md)
129114

130115
</details>
131116

@@ -213,12 +198,14 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
213198
- **Linux/macOS**:
214199
```bash
215200
cd ./infra/scripts/
201+
216202
./docker-build.sh
217203
```
218204
219205
- **Windows (PowerShell)**:
220206
```powershell
221207
cd .\infra\scripts\
208+
222209
.\docker-build.ps1
223210
```
224211
@@ -239,19 +226,35 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
239226
- **Execute Script to registering Schemas**
240227
- Move the folder to samples/schemas in ContentProcessorApi - [/src/ContentProcessorApi/samples/schemas](/src/ContentProcessorApi/samples/schemas)
241228
242-
Bash
229+
230+
Git Bash
231+
232+
```bash
233+
cd src/ContentProcessorAPI/samples/schemas
234+
```
235+
236+
Powershell
237+
238+
```Powershell
239+
cd .\src\ContentProcessorAPI\samples\schemas\
240+
```
241+
242+
- Then use below command
243+
244+
Git Bash
243245
244246
```bash
245247
./register_schema.sh https://<< API Service Endpoint>>/schemavault/ schema_info_sh.json
246248
```
247249
248-
Windows
250+
Powershell
249251
250252
```Powershell
251253
./register_schema.ps1 https://<< API Service Endpoint>>/schemavault/ .\schema_info_ps1.json
252254
```
253255
254256
- **Verify Results**
257+
255258
![schema file registration](./images/SchemaFileRegistration.png)
256259
257260
3. **Import Sample Data**

0 commit comments

Comments
 (0)