docs: Updated the local setup guide for DKM #517
Conversation
Prekshith-Microsoft
requested review from
Avijit-Microsoft,
Dongbumlee,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
nchandhi and
toherman-msft
as code owners
There was a problem hiding this comment.
Pull request overview
This PR significantly enhances the documentation for the Document Knowledge Mining Solution Accelerator by adding comprehensive local development setup guides. It provides detailed, platform-specific instructions for Windows, Linux, and macOS, along with new guides for PowerShell configuration and Azure resource cleanup.
Key improvements:
- Added step-by-step installation instructions for prerequisites (.NET SDK, Node.js, Yarn) across all major OS platforms
- Expanded the LocalSetupGuide.md with detailed backend/frontend setup, Azure role assignments, and comprehensive troubleshooting
- Added two new documentation files for PowerShell PATH configuration and Azure resource deletion
Reviewed changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/LocalSetupGuide.md | Massively expanded from a basic guide to comprehensive instructions covering prerequisites, backend/frontend setup, role assignments, troubleshooting, and cross-references |
| docs/PowershellSetup.md | New guide for adding PowerShell 7 to Windows PATH with detailed steps and troubleshooting |
| docs/DeleteResourceGroup.md | New guide with step-by-step instructions and screenshots for deleting Azure resources after failed deployments |
| docs/images/resourcegroup.png | New screenshot showing Azure resource groups interface |
| docs/images/resource-groups.png | New screenshot showing resource groups list view |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
App/kernel-memory/service/Service/appsettings.Development.json.sample
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 10 changed files in this pull request and generated 11 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This pull request adds and significantly expands documentation to improve the local development experience and troubleshooting for the Document Knowledge Mining Solution Accelerator. It introduces new guides for deleting Azure resources and setting up PowerShell, and greatly enhances the local setup instructions with clearer steps, OS-specific details, and troubleshooting advice.
Major documentation improvements:
Local development setup enhancements:
LocalSetupGuide.mdnow includes detailed, step-by-step instructions for installing prerequisites and configuring the backend and frontend across Windows, Linux, and macOS. It covers tool installation, solution file locations, Azure role assignments, and validation steps for successful setup. [1] [2] [3] [4]New documentation guides:
DeleteResourceGroup.md, a guide with screenshots for safely deleting Azure resource groups and individual resources after failed deployments, including tips for handling locked resources.PowershellSetup.md, a step-by-step guide for adding PowerShell 7 to the PATH on Windows, including troubleshooting tips.Cross-references and related documentation:
LocalSetupGuide.mdnow links to related guides for deployment, resource deletion, PowerShell setup, and Azure quota checks, making it easier for developers to find relevant information.## PurposeDoes this introduce a breaking change?
This pull request adds comprehensive improvements and new documentation to streamline the local development process and resource management for the Document Knowledge Mining Solution Accelerator. The main changes include a major overhaul of the local setup guide, the addition of detailed troubleshooting steps, and new documentation for deleting Azure resources and configuring PowerShell on Windows.
Documentation improvements for local setup and troubleshooting:
LocalSetupGuide.mdto provide step-by-step instructions for setting up the solution on Windows, Linux, and macOS, including platform-specific installation commands for .NET SDK, Node.js, and Yarn. The guide now covers prerequisites, backend and frontend setup, required Azure role assignments, and how to run and debug the application locally. [1] [2] [3] [4] [5]LocalSetupGuide.md, addressing common issues such as server response errors, permission problems on Linux/macOS, Windows-specific configuration, Azure authentication, and environment variable checks.New documentation for resource management:
DeleteResourceGroup.mdwith step-by-step instructions and screenshots for deleting Azure resource groups and individual resources after a failed deployment, including tips on handling locked resources.New documentation for PowerShell configuration:
PowershellSetup.md, a guide for adding PowerShell 7 to the Windows PATH variable, with detailed instructions, troubleshooting tips, and prerequisites.Cross-referencing and related documentation:
These changes significantly improve the developer onboarding experience, clarify resource cleanup procedures, and address common environment setup issues.
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information