Skip to content

style: readme changes #722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 29, 2025
Merged

style: readme changes #722

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c424ed
docs: update deployment guide to clarify VS Code Dev Containers and b…
Kingshuk-Microsoft Oct 29, 2025
ed974e6
docs: update post-deployment instructions to simplify sample data imp…
Kingshuk-Microsoft Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 3 additions & 22 deletions docs/DeploymentGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ You can run this solution using [GitHub Codespaces](https://docs.github.com/en/c
</details>

<details>
<summary><b>Deploy in VS Code</b></summary>
<summary><b>Deploy in VS Code Dev Containers</b></summary>

### VS Code Dev Containers

Expand Down Expand Up @@ -136,26 +136,7 @@ Consider the following settings during your deployment to modify specific settin
<details>
<summary><b>Configurable Deployment Settings</b></summary>

When you start the deployment, most parameters will have **default values**, but you can update the below settings by following the steps [here](CustomizingAzdParameters.md):


| **Setting** | **Description** | **Default value** |
| ------------------------------------ | -------------------------------------------------------------------------------------------------- | ------------------------ |
| **Environment Name** | A **3-20 character alphanumeric value** used to generate a unique ID to prefix the resources. | `azdtemp` |
| **Cosmos Location** | A **less busy** region for **CosmosDB**, useful in case of availability constraints. | `eastus2` |
| **Deployment Type** | Select from a drop-down list (`Standard`, `GlobalStandard`). | `GlobalStandard` |
| **GPT Model** | Azure OpenAI GPT model to deploy. | `gpt-4o-mini` |
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. Choose based on Azure OpenAI quota. | `30` |
| **Embedding Model** | OpenAI embedding model used for vector similarity. | `text-embedding-ada-002` |
| **Embedding Model Capacity** | Set the capacity for **embedding models**. Choose based on usage and quota. | `80` |
| **Image Tag** | The version of the Docker image to use (e.g., `latest_waf`, `dev`, `hotfix`). | `latest_waf` |
| **Azure OpenAI API Version** | Set the API version for OpenAI model deployments. | `2025-04-01-preview` |
| **AZURE_LOCATION** | Sets the Azure region for resource deployment. | `<User selects during deployment>` |
| **Existing Log Analytics Workspace** | To reuse an existing Log Analytics Workspace ID instead of creating a new one. | *(empty)* |
| **Existing AI Foundry Project Resource ID** | To reuse an existing AI Foundry Project Resource ID instead of creating a new one. | *(empty)* |



When you start the deployment, most parameters will have **default values**, but you can update the below settings by following the steps [here](CustomizingAzdParameters.md)

</details>

Expand Down Expand Up @@ -258,7 +239,7 @@ This will rebuild the source code, package it into a container, and push it to t
## Post Deployment Steps

1. **Import Sample Data**
-Run bash command printed in the terminal. The bash command will look like the following:
-please open a **Git Bash** terminal and run the bash command printed below. The bash command will look like the following:
```shell
bash ./infra/scripts/process_sample_data.sh
```
Expand Down