Merge pull request #245 from Azure-Samples/ignite_maunal

Ignite maunal
Azure-Samples · Nov 4, 2024 · 31455c6 · 31455c6
2 parents 5181ea0 + d283fcf
commit 31455c6
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 76 deletions.
diff --git a/docs/workshop/LAB-MANUAL-IGNITE.md b/docs/workshop/LAB-MANUAL-IGNITE.md
diff --git a/docs/workshop/LAB-MANUAL.md b/docs/workshop/LAB-MANUAL.md
@@ -2,15 +2,10 @@
 
 # CREDENTIALS
 
-````
-Username     = "@lab.CloudPortalCredential(User1).Username"
-
+++Username     = "@lab.CloudPortalCredential(User1).Username"
 Password     = "@lab.CloudPortalCredential(User1).Password"
-
 AzureEnvName = "[email protected]"
-
-Subscription = "@lab.CloudSubscription.Id"
-````
+Subscription = "@lab.CloudSubscription.Id"++
 
 
 **If you are viewing this from the Skillable lab page** the above are your unique azure credentials.
@@ -21,7 +16,7 @@ Subscription = "@lab.CloudSubscription.Id"
 
 ***
 
-### Welcome to the AI Tour and workshop WRK551!
+### Welcome to this Microsoft workshop!
 
 In this session, you will learn how to build the app, **Contoso Creative Writer**. This app will assist the marketing team at Contoso Outdoors in creating trendy, well-researched articles to promote the company’s products.
 
@@ -35,32 +30,22 @@ To participate in this workshop, you will need:
 2. A GitHub Account.
     * If you don't have one, you can [signup for a free account](https://github.com/signup) now.
     * After this workshop is complete, you will have a fork of the "contoso-creative-writer" repository in your GitHub account, which includes all the materials you will need to reproduce this workshop at home.
-3. Familiarity with Visual Studio Code.
-    * We will run all code in GitHub Codespaces, a virtualized Linux machine, instead of your local laptop. We won't be running anything on your laptop directly.
-    * VS Code Online will be our development environment in GitHub Codespaces.
-    * If you are familiar with running Codespaces within VS Code Desktop on your laptop, feel free to do so.
-4. (preferred) Familiarity with the *bash* shell.
-    * We'll be using *bash* to run commands in the VS Code terminal.
+
 
 ### To begin this lab follow these steps:
 
 1. Confirm that you can see your **Azure Credentials** at the top of the page. 
     * You will use these to login to Azure Developer CLI (AZD) and Azure CLI (AZ) later. 
 
-2.  Click on this link [https://aka.ms/aitour/wrk551](https://aka.ms/aitour/wrk551). This will take you to the project Github repository.
+2.  Click on this link [https://aka.ms/contoso-creative-writer-codespace](https://aka.ms/contoso-creative-writer-codespace). This will take you to a page where you can open a Codespace for Contoso Creative Writer. 
     * If you are not logged into Github already you will need to login using **your own** GitHub account credentials. 
 
-3. Click the green **<> Code** button in the top-right part of the page.
-    * Click the Codespaces tab
-    * Then click **Create codespace on main**
+3. Click the green **<> Create codespace** button at the bottom of the page.
     * This will open a pre-built Codespace on main. 
 
-    > **🚧 IMPORTANT**: Do not open the GitHub Codespace on a fork of the repository, this would prevent you from using the prebuilt Codespace container image. Don't worry, you'll have the possibility to fork the repository later.
-
 4. Once your Codespace is ready:
     * In the file explorer look for the **docs** folder and in it open the **workshop** folder. 
-    * Open the **WORKSHOP-README.md** file. (There are other Readme files in the folder,specifically open the workshop one.)
+    * Open the **LAB-SETUP.ipynb** file. 
     * Follow the instructions to get going!
-    * When following the steps to login to AZD and AZ in Part 1 of this file, use the [azure credentials](#azure-credentials) at the top of the Skillable manual to login.
 
 Have fun building!🎉
diff --git a/docs/workshop/LAB-SETUP.ipynb b/docs/workshop/LAB-SETUP.ipynb
@@ -8,6 +8,8 @@
     "\n",
     "✨This is a Jupyter Notebook that allows you to run Python code interactively 🐍✨\n",
     "\n",
+    "🚨**Double click on the notebook tab** above to keep the notebook open! \n",
+    "\n",
     "1. Click the **Select Kernel** button on the top right of the notebook.\n",
     "2. Choose **Python environments** and select **Python 3.11**.\n",
     "\n",
@@ -107,7 +109,7 @@
    "source": [
     "2. Sign in to Azure Developer CLI. \n",
     "\n",
-    "    > **🚧 IMPORTANT**: Use the following `username` and `password` when prompted to sign in with an email and password."
+    "    > **🚨 IMPORTANT**: Use the following `username` and `password` when prompted to sign in with an email and password."
    ]
   },
   {
@@ -133,9 +135,11 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "3.  Next we will get the environment variables for your resource group.\n",
+    "### c. Get environment variables (You will need to use the terminal for step 1!)\n",
+    "  \n",
+    "1. Next we will get the environment variables for your resource group.\n",
     "\n",
-    "    > **🚧 IMPORTANT**: You will need to run the output of the next cell **in the terminal!**\n",
+    "    > **🚨 IMPORTANT: You will need to run the output of the next cell in the terminal!**\n",
     "    > \n",
     "    > - Run the cell below and then copy the output and paste it in the terminal and press enter\n",
     "    > - Select `Y` when asked if you'd like to create the environment \n",

diff --git a/docs/workshop/workshop-1-intro.ipynb b/docs/workshop/workshop-1-intro.ipynb
@@ -6,6 +6,8 @@
    "source": [
     "✨This is a Jupyter Notebook that allows you to run Python code interactively 🐍✨\n",
     "\n",
+    "🚨**Double click on the notebook tab** above to keep the notebook open! \n",
+    "\n",
     "**If you have not already:**\n",
     "1. Click the **Select Kernel** button on the top right of the notebook.\n",
     "2. Choose **Python environments** and select **Python 3.11**.\n",

diff --git a/docs/workshop/workshop-2-tracing.ipynb b/docs/workshop/workshop-2-tracing.ipynb
@@ -6,6 +6,8 @@
    "source": [
     "## 2. Utilizing Prompty tracing for debugging and observability\n",
     "\n",
+    "🚨**Double click on the notebook tab** above to keep the notebook open! \n",
+    "\n",
     "When running Applications driven by LLMs, sometimes things don't go as expected! \n",
     "<br>It's important to have a way to debug your LLM workflow so you can see where things are working. \n",
     "<br>Tracing helps you visualize the execution of your prompts and clearly see what inputs are being passed to the LLM. \n",

diff --git a/docs/workshop/workshop-3-build.ipynb b/docs/workshop/workshop-3-build.ipynb
@@ -6,6 +6,8 @@
    "source": [
     "## 3. Building and running Contoso Creative Writer \n",
     "\n",
+    "🚨**Double click on the notebook tab** above to keep the notebook open! \n",
+    "\n",
     "We will now build and run Contoso Creativer Writer a multi-agent application! \n",
     "\n",
     "<div class='alert alert-block alert-success'>\n",

diff --git a/docs/workshop/workshop-4-ci-cd.ipynb b/docs/workshop/workshop-4-ci-cd.ipynb
@@ -6,6 +6,8 @@
    "source": [
     "## 4. Setting up automated evaluations and deployment with Github Actions \n",
     "\n",
+    "🚨**Double click on the notebook tab** above to keep the notebook open! \n",
+    "\n",
     "Contoso Creative Writer is set up to run a CI/CD pipeline, which stands for Continuous Integration and Continuous Deployment. \n",
     "\n",
     "In this sample code the CI/CD pipeline includes the following: \n",