Updated the local setup guide

Author: Prekshith-Microsoft

docs/DeleteResourceGroup.md

@@ -0,0 +1,53 @@
+# Deleting Resources After a Failed Deployment in Azure Portal
+
+If your deployment fails and you need to clean up the resources manually, follow these steps in the Azure Portal.
+
+---
+
+## **1. Navigate to the Azure Portal**
+1. Open [Azure Portal](https://portal.azure.com/).
+2. Sign in with your Azure account.
+
+---
+
+## **2. Find the Resource Group**
+1. In the search bar at the top, type **"Resource groups"** and select it.
+2. Locate the **resource group** associated with the failed deployment.
+
+![Resource Groups](images/resourcegroup.png)
+
+![Resource Groups](images/resource-groups.png)
+
+---
+
+## **3. Delete the Resource Group**
+1. Click on the **resource group name** to open it.
+2. Click the **Delete resource group** button at the top.
+
+![Delete Resource Group](images/DeleteRG.png)
+
+3. Type the resource group name in the confirmation box and click **Delete**.
+
+📌 **Note:** Deleting a resource group will remove all resources inside it.
+
+---
+
+## **4. Delete Individual Resources (If Needed)**
+If you don’t want to delete the entire resource group, follow these steps:
+
+1. Open **Azure Portal** and go to the **Resource groups** section.
+2. Click on the specific **resource group**.
+3. Select the **resource** you want to delete (e.g., App Service, Storage Account).
+4. Click **Delete** at the top.
+
+![Delete Individual Resource](images/deleteservices.png)
+
+---
+
+## **5. Verify Deletion**
+- After a few minutes, refresh the **Resource groups** page.
+- Ensure the deleted resource or group no longer appears.
+
+📌 **Tip:** If a resource fails to delete, check if it's **locked** under the **Locks** section and remove the lock.
+
+

docs/LocalSetupGuide.md

@@ -1,10 +1,75 @@
 # Local Setup Guide
 
-Follow these steps to set up and debug the application locally.
+This guide provides comprehensive instructions for setting up the Document Knowledge Mining Solution Accelerator for local development across Windows, Linux, and macOS platforms.
 
 ---
+## Step 1: Prerequisites - Install Required Tools
+Install these tools before you start:
+- [Visual Studio](https://visualstudio.microsoft.com/)
+- [Visual Studio Code](https://code.visualstudio.com/)
+- [Node.js (LTS)](https://nodejs.org/en).
 
-## Backend Setup
+### Windows Development
+```
+# .NET SDK (LTS .NET 8)
+winget install Microsoft.DotNet.SDK.8
+
+# Yarn (via Corepack) – install Node.js LTS first
+winget install OpenJS.NodeJS.LTS
+corepack enable
+corepack prepare yarn@stable --activate
+
+# Verify
+dotnet --version
+yarn --version
+```
+### Linux Development
+
+#### Ubuntu/Debian
+```
+# .NET SDK (LTS .NET 8)
+sudo apt update && sudo apt install -y dotnet-sdk-8.0
+
+# Yarn (via Corepack) – install Node.js LTS first
+sudo apt install -y nodejs npm
+corepack enable
+corepack prepare yarn@stable --activate
+
+# Verify
+dotnet --version
+yarn --version
+```
+
+#### RHEL/CentOS/Fedora
+```
+# .NET SDK (LTS .NET 8)
+sudo dnf install -y dotnet-sdk-8.0
+
+# Yarn (via Corepack) – install Node.js LTS first
+sudo dnf install -y nodejs npm
+corepack enable
+corepack prepare yarn@stable --activate
+
+# Verify
+dotnet --version
+yarn --version
+```
+### macOS Development
+```
+# .NET SDK (LTS .NET 8)
+brew install --cask dotnet-sdk
+
+# Yarn (via Corepack) – install Node.js first
+brew install node
+corepack enable
+corepack prepare yarn@stable --activate
+
+# Verify
+dotnet --version
+yarn --version
+```
+
+## Step 2: Backend Setup
 
 ### 1. Clone the Repository
 
@@ -15,9 +80,16 @@ git clone https://github.com/microsoft/Document-Knowledge-Mining-Solution-Accele
 ---
 
 ### 2. Sign In to Visual Studio
+#### 1. Open Solutions in Visual Studio
+Navigate to the cloned repository and open the following solution files from Visual Studio:
+
+- **KernelMemory**
+  - Path: `Document-Knowledge-Mining-Solution-Accelerator/App/kernel-memory/KernelMemory.sln`
+
+- **Microsoft.GS.DPS**
+  - Path: `Document-Knowledge-Mining-Solution-Accelerator/App/backend-api/Microsoft.GS.DPS.sln`
 
-- Open the **KernelMemory** and **Microsoft.GS.DPS** solutions in Visual Studio.
-- Sign in using your tenant account with the required permissions.
+#### 2. Sign in to Visual Studio using your **tenant account** with the required permissions.
 
 ---
 
@@ -43,16 +115,25 @@ After deploying the accelerator, the `appsettings.Development.json` file will be
 
 ---
 
+
 ### 5. Assign Required Azure Roles
 
-To enable local debugging and ensure your application can access necessary Azure resources, assign the following roles to your Microsoft Entra ID in the respective services within your deployed resource group in the Azure portal:
+> **Important:**  
+> These roles are required only for local debugging and development.  
+> For production, ensure proper RBAC policies are applied.
 
-- **App Configuration**
-    - App Configuration Data Reader
-- **Storage Account**
-    - Storage Blob Data Contributor
-    - Storage Queue Data Contributor
-    - Storage Blob Data Reader
+1. Sign in to the [Azure Portal](https://portal.azure.com).
+2. Navigate to your **Resource Group** where services are deployed.
+3. Open the **App Configuration**:
+   - Go to **Access control (IAM)** → **Add role assignment**.
+   - Assign to:  
+     `App Configuration Data Reader`
+4. For **Storage Account**:
+   - Go to **Access control (IAM)** → **Add role assignment**.
+   - Assign to:  
+     - `Storage Blob Data Contributor`  
+     - `Storage Queue Data Contributor`  
+     - `Storage Blob Data Reader`
 
 ---
 
@@ -77,12 +158,16 @@ To enable local debugging and ensure your application can access necessary Azure
      ```
 6. Apply the changes.
 
+---
+**After running both solutions, two terminal windows will appear. Once the backend starts successfully, Swagger will start at http://localhost:9001. You can now validate the API endpoints from the Swagger UI to ensure that the backend is running correctly.**
+
 > **Note:**  
 > Always revert this value back to `http://kernelmemory-service` before running the application in Azure.
 
 ---
 
-## Frontend Setup
+
+## Step 3: Frontend Setup
 
 1. Open the repo in **VS Code**.
 2. Navigate to the `App/frontend-app` folder and locate the `.env` file.
@@ -113,4 +198,65 @@ To enable local debugging and ensure your application can access necessary Azure
 
 ---
 
-**You're now ready to run and debug the application locally!**
+**The application will start at https://localhost:52190. You’re now ready to run and debug the application locally!**
+
+---
+
+## Troubleshooting
+
+### Common Issues
+
+
+#### Server Not Responded Issues
+
+- While running the Kernel solution, if you encounter an error such as **“server not responded”** or **“server not found”**, it usually indicates that the required resource is not responding.  
+- Ensure that the necessary **Kubernetes services** are running. If not, start the Kubernetes service and then run the Kernel solution again.
+. 
+
+#### Permission Issues (Linux/macOS)
+
+```bash
+# Fix ownership of files
+sudo chown -R $USER:$USER .
+```
+
+#### Windows-Specific Issues
+
+```powershell
+# PowerShell execution policy
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+
+# Long path support (Windows 10 1607+, run as Administrator)
+New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
+```
+
+### Azure Authentication Issues
+
+```bash
+# Login to Azure CLI
+az login
+
+# Set subscription
+az account set --subscription "your-subscription-id"
+
+# Test authentication
+az account show
+```
+
+### Environment Variable Issues
+
+```bash
+# Check environment variables are loaded
+env | grep AZURE  # Linux/macOS
+Get-ChildItem Env:AZURE*  # Windows PowerShell
+
+# Validate .env file format
+cat .env | grep -v '^#' | grep '='  # Should show key=value pairs
+```
+
+## Related Documentation
+
+- [Deployment Guide](DeploymentGuide.md) - Instructions for production deployment.
+- [Delete Resource Group](DeleteResourceGroup.md) - Steps to safely delete the Azure resource group created for the solution.
+- [Powershell Setup](PowershellSetup.md) - Instructions for setting up PowerShell and required scripts.
+- [Quota Check](QuotaCheck.md) - Steps to verify Azure quotas and ensure required limits before deployment.

docs/PowershellSetup.md

@@ -0,0 +1,45 @@
+# Add PowerShell 7 to PATH in Windows
+
+This guide will help you add **PowerShell 7** (PowerShell Core) to your system’s PATH variable on Windows, so you can easily run it from any Command Prompt or Run dialog.
+
+## Prerequisites
+
+- You should have **PowerShell 7** installed on your machine. If you haven’t installed it yet, you can download it following the guide here: [Installing PowerShell on Windows | Microsoft Learn](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5).
+- **Administrative privileges are not required** unless you're modifying system-wide environment variables. You can modify your **user-specific PATH** without admin rights.
+
+## Steps to Add PowerShell 7 to PATH
+
+### 1. Open **System Properties**
+   - Press `Win + X` and choose **System**.
+   - Click on **Advanced system settings** on the left sidebar. This will open the **System Properties** window.
+   - In the **System Properties** window, click on the **Environment Variables** button at the bottom.
+
+### 2. Edit User Environment Variables
+   - In the **Environment Variables** window, under **User variables**, find the `Path` variable.
+   - Select the `Path` variable and click **Edit**. (If the `Path` variable doesn’t exist, click **New** and name it `Path`.)
+
+### 3. Check if PowerShell 7 Path is Already in PATH
+   - Before adding the path, make sure the following path is not already present in the list:
+     ```
+     C:\Program Files\PowerShell\7\
+     ```
+   - If the path is already there, you don't need to add it again.
+### 4. Add PowerShell 7 Path
+   - If the path is not already in the list, click **New** in the **Edit Environment Variable** window.
+   - Add the following path to the list:
+     ```
+     C:\Program Files\PowerShell\7\
+     ```
+   > **Note:** If you installed PowerShell 7 in a custom location, replace the above path with the correct one.
+### 5. Save Changes
+   - After adding the path, click **OK** to close the **Edit Environment Variable** window.
+   - Click **OK** again to close the **Environment Variables** window.
+   - Finally, click **OK** to exit the **System Properties** window.
+### 6. Verify PowerShell 7 in PATH
+   - Open **Command Prompt** or **Run** (press `Win + R`).
+   - Type `pwsh` and press Enter.
+   - If PowerShell 7 opens, you've successfully added it to your PATH!
+---
+## Troubleshooting
+- **PowerShell 7 not opening:** Ensure the path to PowerShell 7 is entered correctly. If you're using a custom installation folder, check that the correct path is added to the `Path` variable.
+- **Changes not taking effect:** Try restarting your computer or logging out and logging back in for the changes to apply.