-
Notifications
You must be signed in to change notification settings - Fork 98
docs: Added changes in readme file related to SFI #533
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.
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds a new section for local debugging configuration to the deployment guide, providing instructions for setting up environment variables for development purposes.
- Added "For local Debugging" section with environment configuration instructions
- Included guidance on creating
.env
file from.env.sample
template - Specified requirement to set APP_ENV to "dev" for local debugging
To configure your environment, navigate to the `src` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instruction is unclear about where to find the .env.sample
file. Consider specifying the full path (e.g., src/.env.sample
) and provide more detailed steps for filling the environment variables from deployment output.
To configure your environment, navigate to the `src` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". | |
To configure your environment for local debugging: | |
1. Navigate to the `src` folder in your project directory. | |
2. Locate the sample environment file at `src/.env.sample`. | |
3. Copy the sample file to create your own environment file: | |
```sh | |
cp src/.env.sample src/.env | |
``` | |
4. Open `src/.env` in a text editor. | |
5. Fill in the required environment variables using the deployment output from the `azd up` command or by retrieving values from the Azure Portal: | |
- For each variable, refer to the deployment output in your terminal after a successful deployment, or go to the Azure Portal, open your resource group, and check the "Deployments" section for the outputs. | |
- Common variables you may need to fill include: | |
- `AZURE_OPENAI_ENDPOINT` – Find the endpoint URL for your Azure OpenAI resource. | |
- `AZURE_OPENAI_KEY` – Get the API key from the Azure OpenAI resource's "Keys and Endpoint" blade. | |
- `AZURE_SEARCH_SERVICE_NAME` – The name of your Azure AI Search service. | |
- `AZURE_SEARCH_ADMIN_KEY` – The admin key for your Azure AI Search service. | |
- `AZURE_STORAGE_ACCOUNT_NAME` – The name of your Azure Storage account. | |
- `AZURE_STORAGE_ACCOUNT_KEY` – The key for your Azure Storage account. | |
- `AZURE_COSMOSDB_ACCOUNT_NAME` – The name of your CosmosDB account. | |
- `AZURE_COSMOSDB_KEY` – The key for your CosmosDB account. | |
- `APP_ENV` – Set this to `dev` for local debugging. | |
- If you are unsure where to find a value, refer to the Azure Portal: open the relevant resource, and look for the property or key in the "Keys and Endpoint" or "Access keys" section. | |
6. Save the `.env` file after filling in all required values. | |
Ensure that `APP_ENV` is set to `dev` for local debugging. |
Copilot uses AI. Check for mistakes.
To configure your environment, navigate to the `src` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The sentence is quite long and covers multiple steps. Consider breaking it into numbered steps or bullet points for better readability and easier following of the instructions.
To configure your environment, navigate to the `src` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". | |
To configure your environment: | |
1. Navigate to the `src` folder. | |
2. Create a `.env` file based on the `.env.sample` file. | |
3. Fill in the `.env` file using the deployment output or by checking the Azure Portal under "Deployments" in your resource group. | |
4. Ensure that `APP_ENV` is set to "**dev**" in your `.env` file. |
Copilot uses AI. Check for mistakes.
Purpose
Add the content for env changes in DeploymentGuide.md
Does this introduce a breaking change?
Other Information
Added the new section (For local Debugging) in DeploymentGuide.md file