docs: Updates in Deployment Guide, Demonstrate Guide and README file#18
Conversation
Removed asset and products CSV path exports from the guide.
- Update deployment guide table with new section anchors - Link to Step 1-7 sections instead of old flat structure - Maintain all Quick deploy options and badges - Align README navigation with refactored DeploymentGuide
Updated instructions for locating the Data Agent and identifying anomaly spikes in the dashboard. Added step to open Activator from the workspace.
There was a problem hiding this comment.
Pull request overview
This pull request significantly improves the documentation for the Real-Time Intelligence Operations solution accelerator, focusing on clarity, organization, and user guidance for deployment and demonstration workflows.
Key Changes:
- Comprehensive rewrite of the Deployment Guide with step-by-step structure, improved navigation, and expanded troubleshooting sections
- Reorganization of the Demonstrator's Guide with clearer prerequisites and sequential demonstration steps
- Addition of a new Demonstrator Access Requirements guide detailing required roles and permissions
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
docs/EventSimulatorGuide.md |
Removed redundant environment variable documentation (ASSETS_CSV_PATH and PRODUCTS_CSV_PATH) |
docs/DeploymentGuide.md |
Major restructuring with improved sections, enhanced prerequisites documentation, expanded deployment options, added troubleshooting guide, and clearer post-deployment instructions |
docs/DemonstratorGuide.md |
Reorganized demonstration flow with clearer step-by-step instructions, separated access requirements, and improved component descriptions |
docs/DemonstratorAccessRequirement.md |
New guide detailing Fabric workspace contributor access, Activator rule configuration, and Azure Event Hubs Data Sender role requirements |
README.md |
Updated deployment links to reference new section anchors, fixed typo in prerequisites link, and minor formatting improvements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Purpose
Documentation improvements:
DemonstratorAccessRequirement.mdguide detailing the required roles and permissions for demonstrating the solution, including Fabric workspace contributor access and Event Hubs Data Sender role.DemonstratorGuide.mdto provide step-by-step demonstration instructions, clearer prerequisites, and improved explanations of each demo component. The guide now references the new access requirements and provides a summary of capabilities demonstrated.Deployment and setup instructions:
README.mdto clarify prerequisite links and simplify references to the deployment guide, making it easier for users to find detailed setup instructions. [1] [2]EventSimulatorGuide.mdfor environment variable setup instructions.Does this introduce a breaking change?
How to Test
What to Check
Verify that the following are valid
Other Information