Skip to content

Commit 5073bcc

Browse files
authored
Merge pull request #28 from BethanyJep/main
Update Lab Setup and Documentation
2 parents 6687c89 + 264fda7 commit 5073bcc

30 files changed

+1464
-780
lines changed

labs/0-setup/README.self-guided.md

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Setup For Self-Guided Learners
22

3-
🚨🚨🚨 TRACING ENV NEEDS MANUAL UPDATE - TODO: FIX IT 🚨🚨
4-
5-
63
Use this guide if you are working on these labs on your own at home!
74

5+
---
86

9-
## 1. Pre-Requisites
7+
## 📋 1. Pre-Requisites
108

119
You will need:
1210

@@ -18,7 +16,7 @@ You will need:
1816

1917
<br/>
2018

21-
## 2. Setup Dev Environment
19+
## 🚀 2. Setup Dev Environment
2220

2321
First, let's get you set up with a development environment for the lab. The repository is setup with a `devcontainer.json` that provides a pre-build development environment with all tools and dependencies installed. Let's activate that in three steps!
2422

@@ -47,7 +45,7 @@ _Your development environment is ready - and connected to Azure!_
4745

4846
<br/>
4947

50-
## 3. Provision Your AI Agents Resources
48+
## ⚙️ 3. Provision Your AI Agents Resources
5149

5250
1. We'll jumpstart our development using the [Get Started With AI Agents](https://github.com/Azure-Samples/get-started-with-ai-agents) template
5351
1. This provides a solution architecutre with sample code & infrastructure files
@@ -108,7 +106,7 @@ _Let's get this done_
108106

109107
<br/>
110108

111-
## 4. Set up `.env` variables.
109+
## ⚙️ 4. Set up `.env` variables.
112110

113111
1. Make sure you are authenticated with Azure CLI. We will use this to retrieve and create a `.env` file based on the `scripts/.env.sample` format
114112

@@ -124,7 +122,7 @@ _Let's get this done_
124122

125123
<br/>
126124

127-
## 5. Populate Search Data
125+
## 📊 5. Populate Search Data
128126

129127
1. We have Zava data in `scripts/customization`. Let's create a product index in Azure AI Search. Switch to the `scripts/` folder and run the command:
130128
@@ -138,7 +136,7 @@ _Let's get this done_
138136
139137
<br/>
140138
141-
## 6. Add Model Choices
139+
## 🎓 6. Add Model Choices
142140
143141
The default AI Agents template will deploy one chat model. The AI Search index creation will require a second text-embedding model.
144142
@@ -190,7 +188,10 @@ ADDITIONAL_MODEL_DEPLOYMENTS=[{"name":"model-router","model":{"format":"OpenAI",
190188
191189
<br/>
192190
193-
## 7. Validate your `.env` variables
191+
```
192+
193+
194+
## ✅ 7. Validate your `.env` variables
194195
195196
1. It's easy - there's a notebook for that!
196197
1. Open `labs/0-setup/00-validate-setup.ipynb` in your Visual Studio Code editor.
@@ -209,15 +210,15 @@ ADDITIONAL_MODEL_DEPLOYMENTS=[{"name":"model-router","model":{"format":"OpenAI",
209210
```
210211

211212

212-
## 8. (Optional) Refresh Env From Existing Infra
213+
## 🔄 8. (Optional) Refresh Env From Existing Infra
213214

214215
What if you had provisioned infrastructure earlier - but had deleted your Codespaces? Can you _restore_ environment variables from an existing infrastructure?
215216

216217
Yes. Note that the `scripts/1-update-env-selfguided.sh` script only needs your subscription and a resource group, and it can retrieve and update your `.env`.
217218

218219
<br/>
219220

220-
## 5. Complete Your Labs
221+
## 📚 9. Complete Your Labs
221222

222223
_Your infrastructure is now ready! You can now launch the instruction guide and start working through the labs!_.
223224

@@ -235,7 +236,7 @@ _Your infrastructure is now ready! You can now launch the instruction guide and
235236

236237
<br/>
237238

238-
## 6. Teardown & Cleanup
239+
## 🧹 10. Teardown & Cleanup
239240

240241
When you are all done with labs, you want to tear down the infrastructure _and_ delete the cloned template sources from your repo. Make sure you are in the `scripts/` folder then run this command:
241242

@@ -256,4 +257,30 @@ WARNING: This will delete all Azure resources
256257
Tear down Azure infrastructure? (yes/no):
257258
```
258259

259-
Respond with "yes" - and wait till complete. This will take 15-20 minutes to unprovision the resource group and purge resources. _You can now use the `./1-setup.sh` script if you want to restart install from scratch_.
260+
Respond with "yes" - and wait till complete. This will take 15-20 minutes to unprovision the resource group and purge resources. _You can now use the `./1-setup.sh` script if you want to restart install from scratch_.
261+
262+
---
263+
264+
## 🆘 Troubleshooting
265+
266+
### Common issues and solutions
267+
268+
| Issue | Solution |
269+
|-------|----------|
270+
| **Script fails with "Not logged in"** | Run `az login` again and complete authentication |
271+
| **Resource group not found** | Ensure you're using the correct Azure subscription |
272+
| **MkDocs won't start** | Try `pip install -r requirements-dev.txt` first |
273+
| **Notebook kernel not found** | Select the Python kernel from the top-right kernel picker |
274+
| **Bicep deployment fails** | Navigate to `ForBeginners/.azd-setup` and run `azd up` directly |
275+
| **Model deployment conflicts** | Wait a few minutes and retry with `azd up` |
276+
277+
### Additional resources
278+
279+
- �🐛 [Report issues on GitHub](https://github.com/Azure-Samples/ignite25-PREL13/issues)
280+
- 💬 Join our community on Discord to interact with other developers:
281+
282+
[![Discord](https://img.shields.io/badge/Discord-Join%20Community-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/3cmBfTFkH7)
283+
284+
---
285+
286+
**🎉 Congratulations!** Your lab environment is ready. Start exploring the power of Azure AI Foundry!

0 commit comments

Comments
 (0)