Skip to content

Commit 6620f53

Browse files
authored
Fixed markdown violations.
1 parent b4f3922 commit 6620f53

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,15 @@ The repo includes sample data so it's ready to try end to end. In this sample ap
2727
### Prerequisites
2828

2929
#### To Run Locally
30-
- [Azure Developer CLI](https://aka.ms/azure-dev/install)
31-
- [Python 3+](https://www.python.org/downloads/)
32-
- **Important**: Python and the pip package manager must be in the path in Windows for the setup scripts to work.
33-
- **Important**: Ensure you can run `python --version` from console. On Ubuntu, you might need to run `sudo apt install python-is-python3` to link `python` to `python3`.
34-
- [Node.js](https://nodejs.org/en/download/)
35-
- [Git](https://git-scm.com/downloads)
36-
- [Powershell 7+ (pwsh)](https://github.com/powershell/powershell) - For Windows users only.
37-
- **Important**: Ensure you can run `pwsh.exe` from a PowerShell command. If this fails, you likely need to upgrade PowerShell.
30+
31+
* [Azure Developer CLI](https://aka.ms/azure-dev/install)
32+
* [Python 3+](https://www.python.org/downloads/)
33+
* **Important**: Python and the pip package manager must be in the path in Windows for the setup scripts to work.
34+
* **Important**: Ensure you can run `python --version` from console. On Ubuntu, you might need to run `sudo apt install python-is-python3` to link `python` to `python3`.
35+
* [Node.js](https://nodejs.org/en/download/)
36+
* [Git](https://git-scm.com/downloads)
37+
* [Powershell 7+ (pwsh)](https://github.com/powershell/powershell) - For Windows users only.
38+
* **Important**: Ensure you can run `pwsh.exe` from a PowerShell command. If this fails, you likely need to upgrade PowerShell.
3839

3940
>NOTE: Your Azure Account must have `Microsoft.Authorization/roleAssignments/write` permissions, such as [User Access Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#user-access-administrator) or [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner).
4041
@@ -54,7 +55,7 @@ You can run this repo virtually by using GitHub Codespaces or VS Code Remote Con
5455
1. Run `azd init -t azure-search-openai-demo`
5556
* For the target location, the regions that currently support the models used in this sample are **East US** or **South Central US**. For an up-to-date list of regions and models, check [here](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/concepts/models)
5657

57-
#### Starting from scratch:
58+
#### Starting from scratch
5859

5960
Execute the following command, if you don't have any pre-existing Azure services and want to start from a fresh deployment.
6061

@@ -64,10 +65,10 @@ Execute the following command, if you don't have any pre-existing Azure services
6465
It will look like the following:
6566

6667
!['Output from running azd up'](assets/endpoint.png)
67-
68+
6869
> NOTE: It may take a minute for the application to be fully deployed. If you see a "Python Developer" welcome screen, then wait a minute and refresh the page.
6970
70-
#### Use existing resources:
71+
#### Use existing resources
7172

7273
1. Run `azd env set AZURE_OPENAI_SERVICE {Name of existing OpenAI service}`
7374
1. Run `azd env set AZURE_OPENAI_RESOURCE_GROUP {Name of existing resource group that OpenAI service is provisioned to}`
@@ -77,10 +78,12 @@ It will look like the following:
7778

7879
> NOTE: You can also use existing Search and Storage Accounts. See `./infra/main.parameters.json` for list of environment variables to pass to `azd env set` to configure those existing resources.
7980
80-
#### Deploying or re-deploying a local clone of the repo:
81+
#### Deploying or re-deploying a local clone of the repo
82+
8183
* Simply run `azd up`
8284

83-
#### Running locally:
85+
#### Running locally
86+
8487
1. Run `azd login`
8588
2. Change dir to `app`
8689
3. Run `./start.ps1` or `./start.sh` or run the "VS Code Task: Start App" to start the project locally.
@@ -100,6 +103,7 @@ Run the following if you want to give someone else access to completely deployed
100103
* Running locally: navigate to 127.0.0.1:5000
101104

102105
Once in the web app:
106+
103107
* Try different topics in chat or Q&A context. For chat, try follow up questions, clarifications, ask to simplify or elaborate on answer, etc.
104108
* Explore citations and sources
105109
* Click on "settings" to try different options, tweak prompts, etc.
@@ -111,6 +115,7 @@ Once in the web app:
111115
* [Azure OpenAI Service](https://learn.microsoft.com/azure/cognitive-services/openai/overview)
112116

113117
### Note
118+
114119
>Note: The PDF documents used in this demo contain information generated using a language model (Azure OpenAI Service). The information contained in these documents is only for demonstration purposes and does not reflect the opinions or beliefs of Microsoft. Microsoft makes no representations or warranties of any kind, express or implied, about the completeness, accuracy, reliability, suitability or availability with respect to the information contained in this document. All rights reserved to Microsoft.
115120
116121
### FAQ
@@ -121,6 +126,6 @@ Once in the web app:
121126

122127
### Troubleshooting
123128

124-
If you see this error while running `azd deploy`: `read /tmp/azd1992237260/backend_env/lib64: is a directory`, then delete the `./app/backend/backend_env folder` and re-run the `azd deploy` command. This issue is being tracked here: https://github.com/Azure/azure-dev/issues/1237
129+
If you see this error while running `azd deploy`: `read /tmp/azd1992237260/backend_env/lib64: is a directory`, then delete the `./app/backend/backend_env folder` and re-run the `azd deploy` command. This issue is being tracked here: <https://github.com/Azure/azure-dev/issues/1237>
125130

126-
If the web app fails to deploy and you receive a '404 Not Found' message in your browser, run 'azd deploy'.
131+
If the web app fails to deploy and you receive a '404 Not Found' message in your browser, run 'azd deploy'.

0 commit comments

Comments
 (0)