Skip to content

docs: Updates in Deployment Guide, Demonstrate Guide and README file#18

Merged
DocGailZhou merged 16 commits into
mainfrom
gh-updates-1208
Dec 9, 2025
Merged

docs: Updates in Deployment Guide, Demonstrate Guide and README file#18
DocGailZhou merged 16 commits into
mainfrom
gh-updates-1208

Conversation

@Yamini-Microsoft

Copy link
Copy Markdown
Contributor

Purpose

  • This pull request improves the documentation for demonstrating and deploying the Real-Time Intelligence Operations solution. The most significant changes enhance clarity, reorganize demonstration steps, and add a new guide to ensure users have the correct access for demonstrations.

Documentation improvements:

  • Added a new DemonstratorAccessRequirement.md guide detailing the required roles and permissions for demonstrating the solution, including Fabric workspace contributor access and Event Hubs Data Sender role.
  • Significantly rewrote and reorganized the DemonstratorGuide.md to 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:

  • Updated the deployment section in README.md to clarify prerequisite links and simplify references to the deployment guide, making it easier for users to find detailed setup instructions. [1] [2]
  • Minor formatting fix in the EventSimulatorGuide.md for environment variable setup instructions.

Does this introduce a breaking change?

  • Yes
  • No

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

DocGailZhou and others added 12 commits December 8, 2025 11:09
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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
Comment thread docs/DeploymentGuide.md Outdated
Comment thread docs/DemonstratorGuide.md Outdated
Comment thread docs/DemonstratorAccessRequirement.md Outdated
Comment thread docs/DemonstratorAccessRequirement.md Outdated
Yamini-Microsoft and others added 4 commits December 9, 2025 23:36
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>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@DocGailZhou DocGailZhou left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@DocGailZhou DocGailZhou merged commit 3c3c1a9 into main Dec 9, 2025
8 checks passed
@DocGailZhou DocGailZhou deleted the gh-updates-1208 branch December 9, 2025 19:12
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants