Merge pull request #114 from microsoft/readMeupdates2

Read meupdates2

Author: gpickett

README.md

@@ -12,7 +12,7 @@ This accelerator uses the AutoGen framework from Microsoft Research.  This is an
 
 <div align="center">
 
-[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS USE CASE**](#business-use-case) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
+[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS SCENARIO**](#business-scenario) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
 
 </div>
 <br/>
@@ -89,7 +89,7 @@ Follow the quick deploy steps on the deployment guide to deploy this solution to
 
 ### Prerequisites and Costs
 
-To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups and resources**. Follow the steps in [Azure Account Set Up](./docs/AzureAccountSetUp.md).
+To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups and resources**. Follow the steps in [Azure Account Set Up](./documentation/AzureAccountSetUp.md).
 
 Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/table) page and select a **region** where the following services are available: Azure OpenAI Service, Azure AI Search, and Azure Semantic Search.
 
@@ -167,7 +167,7 @@ To ensure continued best practices in your own repository, we recommend that any
 
 You may want to consider additional security measures, such as:
 
-* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/security-center/defender-for-cloud).
+* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/en-us/azure/defender-for-cloud/).
 * Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
 
 <br/>

azure.yaml

@@ -1,18 +1,2 @@
 # yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-dev/main/schemas/v1.0/azure.yaml.json
-
-name: multi-agent-custom-automation-engine-solution-accelerator
-metadata:
-    template: [email protected]
-services:
-    backend:
-        project: src/backend
-        host: containerapp
-        language: python
-        docker:
-            path: Dockerfile
-    frontend:
-        project: src/frontend
-        host: containerapp
-        language: python
-        docker:
-            path: Dockerfile
+name: multi-agent-custom-automation-engine-solution-accelerator

documentation/AzureAccountSetUp.md

@@ -0,0 +1,14 @@
+## Azure account setup
+
+1. Sign up for a [free Azure account](https://azure.microsoft.com/free/) and create an Azure Subscription.
+2. Check that you have the necessary permissions:
+    * Your Azure account must have `Microsoft.Authorization/roleAssignments/write` permissions, such as [Role Based Access Control Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#role-based-access-control-administrator-preview), [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).
+    * Your Azure account also needs `Microsoft.Resources/deployments/write` permissions on the subscription level.
+
+You can view the permissions for your account and subscription by following the steps below: 
+- Navigate to the [Azure Portal](https://portal.azure.com/) and click on `Subscriptions` under 'Navigation' 
+- Select the subscription you are using for this accelerator from the list. 
+    - If you try to search for your subscription and it does not come up, make sure no filters are selected.
+- Select `Access control (IAM)` and you can see the roles that are assigned to your account for this subscription. 
+    - If you want to see more information about the roles, you can go to the `Role assignments`
+     tab and search by your account name and then click the role you want to view more information about.

documentation/DeploymentGuide.md

@@ -5,13 +5,14 @@
   "metadata": {
     "_generator": {
       "name": "bicep",
-      "version": "0.28.1.47646",
-      "templateHash": "1631755345697758847"
+      "version": "0.34.44.8038",
+      "templateHash": "2906892014954666053"
     }
   },
   "parameters": {
     "location": {
       "type": "string",
+      "defaultValue": "EastUS2",
       "metadata": {
         "description": "Location for all resources."
       }
@@ -25,7 +26,7 @@
     },
     "prefix": {
       "type": "string",
-      "defaultValue": "[take(format('macaeo-{0}', uniqueString(resourceGroup().id)), 10)]",
+      "defaultValue": "macaeo",
       "metadata": {
         "description": "A prefix to add to the start of all resource names. Note: A \"unique\" suffix will also be added"
       }
@@ -244,7 +245,6 @@
       },
       "dependsOn": [
         "aiServices",
-        "aoaiUserRoleDefinition",
         "containerApp"
       ]
     },
@@ -403,9 +403,9 @@
       "dependsOn": [
         "aiServices",
         "appInsights",
-        "cosmos::autogenDb",
         "containerAppEnv",
         "cosmos",
+        "cosmos::autogenDb",
         "cosmos::autogenDb::memoryContainer",
         "pullIdentity"
       ],
@@ -500,8 +500,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.28.1.47646",
-              "templateHash": "9096960510978747660"
+              "version": "0.34.44.8038",
+              "templateHash": "10664495342911727649"
             }
           },
           "parameters": {
@@ -638,8 +638,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.28.1.47646",
-              "templateHash": "8215150938757657777"
+              "version": "0.34.44.8038",
+              "templateHash": "12550713338937452696"
             }
           },
           "parameters": {
@@ -1028,8 +1028,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.28.1.47646",
-              "templateHash": "15814429030073463584"
+              "version": "0.34.44.8038",
+              "templateHash": "11364190519186458619"
             }
           },
           "parameters": {

documentation/LocalDeployment.md

@@ -1,5 +1,6 @@
 fastapi
 uvicorn
+
 azure-cosmos
 azure-monitor-opentelemetry
 azure-monitor-events-extension