From 97433c1644fc6496fd96b3ba38fdc44a0861587b Mon Sep 17 00:00:00 2001 From: Chris Harris Date: Wed, 18 Oct 2023 20:42:30 -0700 Subject: [PATCH] Update README.md - Dev Containers (#829) Replace Remote Containers with Dev Containers Add instructions for using Dev Containers --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a09d5e8273..a1f6839465 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ - [Cost estimation](#cost-estimation) - [Project setup](#project-setup) - [GitHub Codespaces](#github-codespaces) - - [VS Code Remote Containers](#vs-code-remote-containers) + - [VS Code Dev Containers](#vs-code-dev-containers) - [Local environment](#local-environment) - [Deploying from scratch](#deploying-from-scratch) - [Deploying with existing Azure resources](#deploying-with-existing-azure-resources) @@ -28,7 +28,7 @@ - [Troubleshooting](#troubleshooting) [![Open in GitHub Codespaces](https://img.shields.io/static/v1?style=for-the-badge&label=GitHub+Codespaces&message=Open&color=brightgreen&logo=github)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=599293758&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2) -[![Open in Remote - Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-search-openai-demo) +[![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-search-openai-demo) This sample demonstrates a few approaches for creating ChatGPT-like experiences over your own data using the Retrieval Augmented Generation pattern. It uses Azure OpenAI Service to access the ChatGPT model (gpt-35-turbo), and Azure Cognitive Search for data indexing and retrieval. @@ -87,11 +87,16 @@ You can run this repo virtually by using GitHub Codespaces, which will open a we [![Open in GitHub Codespaces](https://img.shields.io/static/v1?style=for-the-badge&label=GitHub+Codespaces&message=Open&color=brightgreen&logo=github)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=599293758&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2) -#### VS Code Remote Containers +#### VS Code Dev Containers -A related option is VS Code Remote Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): +A related option is VS Code Dev Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): -[![Open in Remote - Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-search-openai-demo) +1. Start Docker Desktop (install it if not already installed) +1. Open the project: + [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-search-openai-demo) +1. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window +1. Run `azd auth login` +1. Now you can follow the instructions in [Deploying from scratch](#deploying-from-scratch) below #### Local environment