Merge pull request #191 from Azure-Samples/build_workshop

updating build notebook for workshop.
Azure-Samples · Sep 24, 2024 · e9b262b · e9b262b
2 parents df9f6d6 + 00b0c27
commit e9b262b
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 15 deletions.
diff --git a/docs/workshop/WORKSHOP-README.md b/docs/workshop/WORKSHOP-README.md
@@ -67,4 +67,12 @@ You are now ready to start understanding and building Contoso Creative Writer!
 
 ## Part 2: Understanding and Building Contoso Creative Writer
 
-Once you've succesfully run the commands above, open the [workshop-1-intro.ipynb](workshop-1-intro.ipynb) file to continue the workshop! 
+### Learning Outcomes
+In this section we will focus on four key outcomes, each split into their own notebook:
+
+1. [Understanding agents and prompt engineering with Prompty.](./workshop-1-intro.ipynb)
+2. [Utilizing Prompty tracing for debugging and observability.](./workshop-2-tracing.ipynb)
+3. [Building and running Contoso Creative Writer.](./workshop-3-build.ipynb)
+4. [Setting up automated evaluations with GitHub Actions.](./workshop-4-ci-cd.ipynb)
+
+Once you've succesfully run the commands above, open the [workshop-1-intro.ipynb](workshop-1-intro.ipynb) file to being the first learning outcome!  
diff --git a/docs/workshop/workshop-2-tracing.ipynb b/docs/workshop/workshop-2-tracing.ipynb
@@ -101,6 +101,7 @@
     "> **TODO 2:** To fix this bug go to the [social.prompty](socialmedia/social.prompty) file and edit the *max_tokens* amount to make it 1500. \n",
     "><br>Rerun the code in the cell above and confirm the full thread is generated!\n",
     "\n",
+    "**Step 2 Complete ✅**\n",
     "\n",
     "##### Congratulations you've succesfully used Prompty tracing for debugging🎉\n",
     "- [✅] Step 1: Run the code for social media agent\n",

diff --git a/docs/workshop/workshop-3-build.ipynb b/docs/workshop/workshop-3-build.ipynb
@@ -11,13 +11,17 @@
     "- [ ] Step 2: Start the Web Server\n",
     "- [ ] Step 3: Test the app\n",
     "\n",
-    "**You will need to use the terminal to complete the steps:** \n",
-    "- If it’s not already visible, you can open the terminal by clicking on the hamburger menu at the top left of the page \n",
-    "- Click Terminal and select New Terminal.\n",
-    "- Copy and paste the commands in each step into the terminal and press enter to run them. \n",
+    "**🖥️ You will need to use the terminal to complete the steps in this section:** \n",
+    "> - If it’s not already visible, you can open the terminal by clicking on the hamburger menu at the top left of the page \n",
+    "> - Click Terminal and select New Terminal.\n",
     "\n",
     "##### **Step 1:** Start the FastAPI server \n",
     "\n",
+    "Complete the following tasks...\n",
+    "\n",
+    "---\n",
+    "<img src=\"todo.png\" alt=\"todo icon\" width=\"40\" height=\"40\"> **Tasks for you to do:**\n",
+    "\n",
     "1. We'll start by navigating to the correct folder\n",
     "\n",
     "    Run the following command:\n",
@@ -41,8 +45,15 @@
     "\n",
     "To complete this step once the ports are public navigate back to the terminal tab and confirm that you can see *Application startup complete*. \n",
     "\n",
+    "**Step 1 Complete ✅**\n",
+    "\n",
     "##### **Step 2:** Start the web server\n",
     "\n",
+    "Complete the following tasks...\n",
+    "\n",
+    "---\n",
+    "<img src=\"todo.png\" alt=\"todo icon\" width=\"40\" height=\"40\"> **Tasks for you to do:**\n",
+    "\n",
     "1. Open a **new terminal** \n",
     "\n",
     "    Once you've completed the above steps. You'll need to open a **new terminal** and navigate to the web folder. \n",
@@ -74,23 +85,36 @@
     "\n",
     "To complete this step confirm that you can see the Constoso Creative Writer application. \n",
     "\n",
+    "**Step 2 Complete ✅**\n",
+    "\n",
     "##### **Step 3:** Test the app\n",
     "\n",
-    "- You can now test out the app by clicking **Example** to fill out the example information. Read the example instructions. \n",
-    "- Click **Start Work** button to get Contoso Creative Writer to generate an article. \n",
-    "- Click on the small **Debug** button at the bottom right of the Application to see which agent steps are carried out.\n",
+    "Complete the following tasks...\n",
+    "\n",
+    "---\n",
+    "<img src=\"todo.png\" alt=\"todo icon\" width=\"40\" height=\"40\"> **Tasks for you to do:**\n",
+    "\n",
+    "\n",
+    "1. Click the **Example** button to fill out the example information. Read the example instructions. \n",
+    "\n",
+    "2. **Start Work** button to get Contoso Creative Writer to generate an article. \n",
+    "\n",
+    "3. Click on the small **Debug** button at the bottom right of the Application to see which agent steps are carried out.\n",
     "\n",
     "To complete this step confirm that an article was generated that includes citation links and the products requested. \n",
     "\n",
+    "**Step 3 Complete ✅**\n",
+    "\n",
     "##### Congratulations you've succesfully built and ran Contoso Creative Writer🎉\n",
     "- [✅] Step 1: Start the FastAPI server \n",
     "- [✅] Step 2: Start the Web Server\n",
     "- [✅] Step 3: Test the app\n",
     "\n",
     "You've now almost completed the workshop, let's move on to the final learning outcome!\n",
     "\n",
-    "⏰**Note:** The next step takes a bit longer to complete: \n",
-    "- Remember this lab is self paced so you can always complete it on your own, even after the session. "
+    "> ⏰**Note:** The next step takes a bit longer to complete: \n",
+    "> - Remember this lab is self paced so you can always complete it on your own, even after the session. \n",
+    ">"
    ]
   },
   {
@@ -99,11 +123,6 @@
    "source": [
     "➡️ **Open [next workshop notebook](./workshop-4-ci-cd.ipynb)**"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": []
   }
  ],
  "metadata": {