Merge branch 'main' of https://github.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator into psl-pk-km-sqlagent

Pavan-Microsoft · Pavan-Microsoft · commit 3275ddde91f2 · 2025-07-08T15:33:47.000+05:30
diff --git a/.github/workflows/Broken-links-checker-final.yml b/.github/workflows/Broken-links-checker-final.yml
@@ -0,0 +1,57 @@
+name: Broken Link Checker
+
+on:
+  pull_request:
+    paths:
+      - '**/*.md'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  markdown-link-check:
+    name: Check Markdown Broken Links
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # For PR : Get only changed markdown files
+      - name: Get changed markdown files (PR only)
+        id: changed-markdown-files
+        if: github.event_name == 'pull_request'
+        uses: tj-actions/changed-files@ed68ef82c095e0d48ec87eccea555d944a631a4c # v46
+        with:
+          files: |
+            **/*.md
+
+
+      # For PR: Check broken links only in changed files
+      - name: Check Broken Links in Changed Markdown Files
+        id: lychee-check-pr
+        if: github.event_name == 'pull_request' && steps.changed-markdown-files.outputs.any_changed == 'true'
+        uses: lycheeverse/lychee-action@v2.4.1
+        with:
+          args: >
+            --verbose --exclude-mail --no-progress --exclude ^https?://
+            ${{ steps.changed-markdown-files.outputs.all_changed_files }}
+          failIfEmpty: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      # For manual trigger: Check all markdown files in repo
+      - name: Check Broken Links in All Markdown Files in Entire Repo (Manual Trigger)
+        id: lychee-check-manual
+        if: github.event_name == 'workflow_dispatch'
+        uses: lycheeverse/lychee-action@v2.4.1
+        with:
+          args: >
+            --verbose --exclude-mail --no-progress --exclude ^https?://
+            '**/*.md'
+          failIfEmpty: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/deploy-KMGeneric.yml b/.github/workflows/deploy-KMGeneric.yml
@@ -120,7 +120,7 @@ jobs:
           az deployment group create \
             --resource-group ${{ env.RESOURCE_GROUP_NAME }} \
             --template-file infra/main.bicep \
-            --parameters environmentName=${{env.SOLUTION_PREFIX}} contentUnderstandingLocation="swedencentral" secondaryLocation="${{ env.AZURE_LOCATION }}" imageTag=${{ steps.determine_tag.outputs.tagname }} gptDeploymentCapacity=150
+            --parameters environmentName=${{env.SOLUTION_PREFIX}} contentUnderstandingLocation="swedencentral" secondaryLocation="${{ env.AZURE_LOCATION }}" imageTag=${{ steps.determine_tag.outputs.tagname }} gptDeploymentCapacity=150 aiDeploymentsLocation="${{ env.AZURE_LOCATION }}"
 
      
 
diff --git a/docs/workshop/docs/workshop/Challenge-1/Deployment.md b/docs/workshop/docs/workshop/Challenge-1/Deployment.md
@@ -3,7 +3,7 @@ We will set up the initial environment for you to build on top of during your Mi
 
 ### **Prerequisites**
 
-- 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](../../../../../documents/AzureAccountSetUp.md)
 - [VS Code](https://code.visualstudio.com/download) installed locally
 
 
@@ -15,20 +15,20 @@ Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/g
 - Azure AI Content Understanding
 - Embedding Deployment Capacity  
 - GPT Model Capacity
-- [Azure Semantic Search](../../../../docs/AzureSemanticSearchRegion.md)  
+- [Azure Semantic Search](../../../../../documents/AzureSemanticSearchRegion.md)  
 
 Here are some example regions where the services are available: East US2
 
 ### ⚠️ Important: Check Azure OpenAI Quota Availability  
 
-➡️ To ensure sufficient quota is available in your subscription, please follow **[Quota check instructions guide](../../../../docs/QuotaCheck.md)** before you deploy the solution.
+➡️ To ensure sufficient quota is available in your subscription, please follow **[Quota check instructions guide](../../../../../documents/QuotaCheck.md)** before you deploy the solution.
 
 
 ### Quota Recommendations  
 By default, the **GPT model capacity** in deployment is set to **30k tokens**.  
 > **We recommend increasing the capacity to 120k tokens for optimal performance.** 
 
-To adjust quota settings, follow these [steps](../../../../docs/AzureGPTQuotaSettings.md)  
+To adjust quota settings, follow these [steps](../../../../../documents/AzureGPTQuotaSettings.md)  
 
 
 
@@ -84,6 +84,6 @@ Additional Steps
 
 1. **Optional**: Add App Authentication
    
-    Follow steps in [App Authentication](../../../../docs/AppAuthentication.md) to configure authenitcation in app service.
+    Follow steps in [App Authentication](../../../../../documents/AppAuthentication.md) to configure authenitcation in app service.
 
     Note: Authentication changes can take up to 10 minutes 
diff --git a/docs/workshop/docs/workshop/Challenge-3-and-4/Challenge-3.md b/docs/workshop/docs/workshop/Challenge-3-and-4/Challenge-3.md
@@ -5,7 +5,7 @@ One of the easiest and most fun changes you can make to the app is updating the
 ---
 
 ### Step 1: Prepare Your New Logo
-1. Create or use a new logo (e.g [Contoso Img logo](../../../../src/App/src/Assets/ContosoImg.png)) in `src/app/src/Assets/`.
+1. Create or use a new logo (e.g [Contoso Img logo](../../../../../src/App/src/Assets/ContosoImg.png)) in `src/app/src/Assets/`.
 2. Save the logo as an image file (e.g., `logo.png`).
 3. Ensure the image has a reasonable size (e.g., 100x100 pixels) for better display.
 4. Place the logo file in the following folder:
diff --git a/docs/workshop/docs/workshop/Challenge-5/index.md b/docs/workshop/docs/workshop/Challenge-5/index.md
@@ -10,8 +10,8 @@ Content Understanding is an innovative solution designed to analyze and interpre
 
 | File | Description |
 | --- | --- |
-| [video_chapter_generation.ipynb](video_chapter_generation.ipynb) | Extract semantic descriptions using content understanding API, and then leverage OpenAI to group into video chapters. |
-| [video_tag_generation.ipynb](video_tag_generation.ipynb) | Generate video tags based on Azure Content Understanding and Azure OpenAI. |
+| [video_chapter_generation.ipynb](../Challenge-5/notebooks/video_chapter_generation.ipynb) | Extract semantic descriptions using content understanding API, and then leverage OpenAI to group into video chapters. |
+| [video_tag_generation.ipynb](../Challenge-5/notebooks/video_tag_generation.ipynb) | Generate video tags based on Azure Content Understanding and Azure OpenAI. |
 
 ## Getting started
 
diff --git a/docs/workshop/docs/workshop/index.md b/docs/workshop/docs/workshop/index.md
@@ -10,5 +10,5 @@ An analyst managing large volumes of conversational data needs a solution to vis
  
 ### Technical key features
 
-![image](../workshop/support-docs/Images/ReadMe/techkeyfeatures.png)
+![image](../workshop/img/ReadMe/techkeyfeatures.png)
 
diff --git a/documents/CustomizingAzdParameters.md b/documents/CustomizingAzdParameters.md
@@ -21,7 +21,8 @@ By default this template will use the environment name as the prefix to prevent
 | `AZURE_OPENAI_EMBEDDING_MODEL`            | string  | `text-embedding-ada-002` | Sets the name of the embedding model to use.                               |
 | `AZURE_ENV_IMAGETAG`                      | string  | `latest`        | Sets the image tag (`latest`, `dev`, `hotfix`, etc.).   |
 | `AZURE_OPENAI_EMBEDDING_MODEL_CAPACITY`   | integer | `80`                     | Sets the capacity for the embedding model deployment.                      |
-| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID`    | string  | `<Existing Workspace Id>`            | Reuses an existing Log Analytics Workspace instead of creating a new one.  |
+| `AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID`    | string  | Guide to get your [Existing Workspace ID](/documents/re-use-log-analytics.md)            | Reuses an existing Log Analytics Workspace instead of creating a new one.  |
+| `USE_LOCAL_BUILD`    | string  | `false`           | Indicates whether to use a local container build for deployment.  |
 | `AZURE_EXISTING_AI_PROJECT_RESOURCE_ID`    | string  | `<Existing AI Project resource Id>`            | Reuses an existing AIFoundry and AIFoundryProject instead of creating a new one.  |
 
 
@@ -38,4 +39,4 @@ azd env set <PARAMETER_NAME> <VALUE>
 
 ```bash
 azd env set AZURE_LOCATION westus2
-```
+```
diff --git a/documents/DeploymentGuide.md b/documents/DeploymentGuide.md
@@ -137,6 +137,13 @@ Depending on your subscription quota and capacity, you can [adjust quota setting
 
 **⚠️ Warning:** Insufficient quota can cause deployment errors. Please ensure you have the recommended capacity or request additional capacity before deploying this solution.
 
+</details>
+<details>
+
+  <summary><b>Reusing an Existing Log Analytics Workspace</b></summary>
+
+  Guide to get your [Existing Workspace ID](/documents/re-use-log-analytics.md)
+
 </details>
 
 ### Deploying with AZD
diff --git a/documents/Images/re_use_log/logAnalytics.png b/documents/Images/re_use_log/logAnalytics.png
diff --git a/documents/Images/re_use_log/logAnalyticsJson.png b/documents/Images/re_use_log/logAnalyticsJson.png
diff --git a/documents/Images/re_use_log/logAnalyticsList.png b/documents/Images/re_use_log/logAnalyticsList.png
diff --git a/documents/re-use-log-analytics.md b/documents/re-use-log-analytics.md
@@ -0,0 +1,31 @@
+[← Back to *DEPLOYMENT* guide](/documents/DeploymentGuide.md#deployment-options--steps)
+
+# Reusing an Existing Log Analytics Workspace
+To configure your environment to use an existing Log Analytics Workspace, follow these steps:
+---
+### 1. Go to Azure Portal
+Go to https://portal.azure.com
+
+### 2. Search for Log Analytics
+In the search bar at the top, type "Log Analytics workspaces" and click on it and click on the workspace you want to use.
+
+![alt text](../documents/Images/re_use_log/logAnalyticsList.png)
+
+### 3. Copy Resource ID
+In the Overview pane, Click on JSON View
+
+![alt text](../documents/Images/re_use_log/logAnalytics.png)
+
+Copy Resource ID that is your Workspace ID
+
+![alt text](../documents/Images/re_use_log/logAnalyticsJson.png)
+
+### 4. Set the Workspace ID in Your Environment
+Run the following command in your terminal
+```bash
+azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID '<Existing Log Analytics Workspace Id>'
+```
+Replace `<Existing Log Analytics Workspace Id>` with the value obtained from Step 3.
+
+### 5. Continue Deployment
+Proceed with the next steps in the [deployment guide](/documents/DeploymentGuide.md#deployment-options--steps).

Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@ An analyst managing large volumes of conversational data needs a solution to vis`
`10`	`10`
`11`	`11`	`### Technical key features`
`12`	`12`
`13`		`-![image](../workshop/support-docs/Images/ReadMe/techkeyfeatures.png)`
	`13`	`+![image](../workshop/img/ReadMe/techkeyfeatures.png)`
`14`	`14`