-
Notifications
You must be signed in to change notification settings - Fork 6k
Add missing Microsoft.Orleans.Streaming NuGet package requirement to Orleans 7.0 streaming quickstart #49374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…7.0 streaming quickstart Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR addresses a documentation gap in the Orleans streaming quickstart guide by adding information about the required Microsoft.Orleans.Streaming NuGet package for Orleans 7.0. Users were encountering errors when attempting to use the AddMemoryStreams extension method because the guide didn't mention the prerequisite package installation.
Key Changes:
- Added explicit documentation of the
Microsoft.Orleans.StreamingNuGet package requirement - Placed the package information in the "Required configurations" section before code examples
- Included a direct link to the NuGet package page
|
|
||
| In this guide, you use a memory-based stream that uses grain messaging to send stream data to subscribers. You use the in-memory storage provider to store lists of subscriptions. Using memory-based mechanisms for streaming and storage is intended only for local development and testing, not for production environments. | ||
|
|
||
| Orleans streaming requires the [Microsoft.Orleans.Streaming](https://www.nuget.org/packages/Microsoft.Orleans.Streaming) NuGet package. This package provides the streaming functionality for both the client and server, including the `AddMemoryStreams` extension method used in this guide. |
Copilot
AI
Oct 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AI-generated content must include the ai-usage: ai-assisted frontmatter key/value pair. Since this PR was created with AI assistance (as indicated by the Copilot coding agent suffix in the description), please add this frontmatter to the document if it's not already present.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change LGTM.
Summary
Fixes the issue where the Orleans streaming quickstart guide doesn't mention that the
Microsoft.Orleans.StreamingNuGet package is required for Orleans 7.0, leading to confusion when users try to use theAddMemoryStreamsextension method.Problem
Users following the quickstart guide encounter errors when attempting to call
AddMemoryStreamsbecause the required NuGet package isn't documented. The guide jumps directly into configuration code without mentioning the prerequisite package installation.Solution
Added a clear statement in the Orleans 7.0 section of the quickstart that specifies:
Microsoft.Orleans.StreamingNuGet package is requiredAddMemoryStreamsextension method used in the guideThe addition follows the same documentation pattern used in other Orleans streaming pages (such as Azure Queue streams) and is placed prominently in the "Required configurations" section before the configuration code examples.
Notes
This change only affects the Orleans 7.0 section, as Orleans 3.x uses the Simple Message Stream provider which is included in the
Microsoft.Orleans.OrleansProviderspackage (already part of the Server and Client meta-packages).Closes #[issue-number]
Original prompt
Fixes #39640
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.
Internal previews