Merge pull request #476 from microsoft/main

fix: downmerge from main

Author: Pavan-Microsoft

.devcontainer/devcontainer.json

@@ -3,7 +3,8 @@
     "image": "mcr.microsoft.com/devcontainers/python:3.11-bullseye",
     "forwardPorts": [50505],
     "features": {
-        "ghcr.io/azure/azure-dev/azd:latest": {}
+        "ghcr.io/azure/azure-dev/azd:latest": {},
+        "ghcr.io/devcontainers/features/azure-cli:1": {}
     },
     "customizations": {
         "vscode": {

.devcontainer/setup_env.sh

@@ -5,4 +5,5 @@ git pull
 
 # provide execute permission to quotacheck script
 sudo chmod +x ./infra/scripts/checkquota_km.sh
-sudo chmod +x ./infra/scripts/quota_check_params.sh
+sudo chmod +x ./infra/scripts/quota_check_params.sh
+sudo chmod +x ./infra/scripts/run_process_data_scripts.sh

.github/workflows/deploy.yml

@@ -1,43 +1,3 @@
-# name: Deploy MkDocs site to GitHub Pages
-
-# on:
-#   push:
-#     branches:
-#       - main
-
-# jobs:
-#   deploy:
-#     runs-on: ubuntu-latest
-
-#     steps:
-#       # Checkout the repo
-#       - name: Checkout repo
-#         uses: actions/checkout@v3
-
-#       # Set up Python environment
-#       - name: Set up Python
-#         uses: actions/setup-python@v4
-#         with:
-#           python-version: '3.x'
-
-#       # Install MkDocs and Material theme
-#       - name: Install MkDocs & Material theme
-#         run: |
-#           pip install mkdocs-material mkdocs-jupyter
-
-#       # Build the MkDocs site
-#       - name: Build the site
-#         run: |
-#           cd workshop
-#           mkdocs build
-#           touch site/.nojekyll  # Disable Jekyll
-
-#       # Deploy to GitHub Pages
-#       - name: Deploy to GitHub Pages
-#         uses: peaceiris/actions-gh-pages@v3
-#         with:
-#           github_token: ${{ secrets.GITHUB_TOKEN }}
-#           publish_dir: workshop/site
 
 name: Deploy MkDocs site to GitHub Pages
 
@@ -46,6 +6,11 @@ on:
     branches:
       - main
 
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest

README.md

@@ -72,12 +72,12 @@ Follow the quick deploy steps on the deployment guide to deploy this solution
 <br/>
 
 > ⚠️ **Important: Check Azure OpenAI Quota Availability**
- <br/>To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/QuotaCheck.md) before you deploy the solution.
+ <br/>To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./documents/QuotaCheck.md) before you deploy the solution.
 
 <br/>
 
 ### 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, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and  Role Based Access Control role on the subscription and/or resource group level. 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, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and  Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](./documents/AzureAccountSetUp.md).
 
 Here are some example regions where the services are available: East US, East US2, Australia East, UK South, France Central.
 
@@ -204,4 +204,4 @@ You acknowledge that the Software and Microsoft Products and Services (1) are no
 
 You acknowledge the Software is not subject to SOC 1 and SOC 2 compliance audits. No Microsoft technology, nor any of its component technologies, including the Software, is intended or made available as a substitute for the professional advice, opinion, or judgement of a certified financial services professional. Do not use the Software to replace, substitute, or provide professional financial advice or judgment.  
 
-BY ACCESSING OR USING THE SOFTWARE, YOU ACKNOWLEDGE THAT THE SOFTWARE IS NOT DESIGNED OR INTENDED TO SUPPORT ANY USE IN WHICH A SERVICE INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE COULD RESULT IN THE DEATH OR SERIOUS BODILY INJURY OF ANY PERSON OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (COLLECTIVELY, “HIGH-RISK USE”), AND THAT YOU WILL ENSURE THAT, IN THE EVENT OF ANY INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE, THE SAFETY OF PEOPLE, PROPERTY, AND THE ENVIRONMENT ARE NOT REDUCED BELOW A LEVEL THAT IS REASONABLY, APPROPRIATE, AND LEGAL, WHETHER IN GENERAL OR IN A SPECIFIC INDUSTRY. BY ACCESSING THE SOFTWARE, YOU FURTHER ACKNOWLEDGE THAT YOUR HIGH-RISK USE OF THE SOFTWARE IS AT YOUR OWN RISK.
+BY ACCESSING OR USING THE SOFTWARE, YOU ACKNOWLEDGE THAT THE SOFTWARE IS NOT DESIGNED OR INTENDED TO SUPPORT ANY USE IN WHICH A SERVICE INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE COULD RESULT IN THE DEATH OR SERIOUS BODILY INJURY OF ANY PERSON OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (COLLECTIVELY, “HIGH-RISK USE”), AND THAT YOU WILL ENSURE THAT, IN THE EVENT OF ANY INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE, THE SAFETY OF PEOPLE, PROPERTY, AND THE ENVIRONMENT ARE NOT REDUCED BELOW A LEVEL THAT IS REASONABLY, APPROPRIATE, AND LEGAL, WHETHER IN GENERAL OR IN A SPECIFIC INDUSTRY. BY ACCESSING THE SOFTWARE, YOU FURTHER ACKNOWLEDGE THAT YOUR HIGH-RISK USE OF THE SOFTWARE IS AT YOUR OWN RISK.

docs/workshop/README.md

@@ -1,8 +1,6 @@
 # Conversation Knowledge Mining Solution Accelerator: Hands-on Workshop
 
 | [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator) | [![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/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator) | 
-|---|---|
-
 
 
 ### About the Conversation Knowledge Mining Solution Accelerator

docs/workshop/mkdocs.yml

@@ -1,6 +1,6 @@
 # Project information .........................................
 site_name: "Knowledge Mining Microhack: Workshop Guide"
-site_url: https://blessing-sanusi.github.io/microhack-doc/
+site_url: https://microsoft.github.io/Conversation-Knowledge-Mining-Solution-Accelerator
 site_author: bsanusi
 site_description: >-
   Knowlege mining AI solution accelerator for Azure OpenAI Service and Azure Cognitive Search.

documents/CustomizeData.md

@@ -11,13 +11,13 @@ If you would like to update the solution to leverage your own data please follow
 1. Navigate to the storage account in the resource group you are using for this solution. 
 2. Open the `data` container
 3. If you have audio files, upload them to `custom_audiodata` folder. If you have call transcript files, upload them to `custom_transcripts` folder.
-4. Navigate to the terminal and run the `run_process_data_script.sh` to process the new data into the solution with the following commands. 
+4. Navigate to the terminal and run the `run_process_data_scripts.sh` to process the new data into the solution with the following commands. 
     ```shell
     cd infra/scripts
 
     az login
 
-    bash run_process_data_script.sh resourcegroupname_param
+    bash run_process_data_scripts.sh resourcegroupname_param
     ```
     a. resourcegroupname_param - the name of the resource group.