Skip to content

Use Orleans with .NET Aspire #840

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

Merged
merged 22 commits into from
May 9, 2024
Merged

Conversation

ReubenBond
Copy link
Member

@ReubenBond ReubenBond commented May 3, 2024

Summary

First pass at Orleans + Aspire doc

Fixes #702
Fixes #808

Ideas for future improvement:

  • Add section showing how to add multiple storage providers
  • Add deployment section? Unsure it's needed
  • Add section on extensibility: how to ensure that your Orleans providers work with .NET Aspire. The rough answer is that you add an assembly-wide Attribute and a config class to your provider library which understands how to read Config generated by Aspire and configure your provider with it.

Internal previews

📄 File 🔗 Preview link
docs/frameworks/orleans.md Use Orleans with .NET Aspire

@ReubenBond ReubenBond requested a review from IEvangelist as a code owner May 3, 2024 21:55
@dotnet-bot dotnet-bot added the fundamentals Content related to fundamentals. label May 3, 2024
@IEvangelist
Copy link
Member

This will need a TOC entry, and maybe even a hub page listing. Are the TODO's here indicating that this is a draft, or is it ready for review?

@ReubenBond
Copy link
Member Author

The TODOs are future improvements - they're not needed for the first version

@davidfowl
Copy link
Member

Probably doesn't belong under fundamentals. Maybe we have another top level section for framework integrations.

@ReubenBond
Copy link
Member Author

ReubenBond commented May 6, 2024

@IEvangelist what are your thoughts on what the new section should be called? "Frameworks"? Perhaps SignalR should also be in the same section. Currently, it has its own section, Real-time communication.

@IEvangelist
Copy link
Member

The TODOs are future improvements - they're not needed for the first version

Good to know, it's probably worth placing those inside the article as well as a comment so that we have it for later - we could even create an issue to track those improvements too. Use HTML comments in the MD:

<!--
Ideas for future improvement:

- Add section showing how to add multiple storage providers
- Add deployment section? Unsure it's needed
- Add section on extensibility: how to ensure that your Orleans providers work with .NET Aspire. The rough answer is that you add an assembly-wide attribute and a config class to your provider library which understands how to read config generated by .NET Aspire and configure your provider with it.
-->

@IEvangelist
Copy link
Member

@IEvangelist what are your thoughts on what the new section should be called? "Frameworks"? Perhaps SignalR should also be in the same section. Currently, it has its own section, Real-time communication.

I like that, "Frameworks" as a new top-level node with those seems to fit nicely.

Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

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

This is a great start, several nits - and a few other suggestions!

github-actions bot and others added 16 commits May 8, 2024 16:03
✅ Merge `main` into `live`
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
@ReubenBond
Copy link
Member Author

Since the SignalR page is specifically about Azure SignalR, maybe I should leave it where it is

@ReubenBond
Copy link
Member Author

Ok, I think this is ready, @IEvangelist. Please take another look when you're available

@IEvangelist IEvangelist enabled auto-merge (squash) May 9, 2024 00:14
@IEvangelist IEvangelist merged commit 5e1fa76 into dotnet:main May 9, 2024
@ReubenBond ReubenBond deleted the rebond/orleans branch May 9, 2024 21:13
@ReubenBond
Copy link
Member Author

Thanks for getting this over the line, @IEvangelist!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fundamentals Content related to fundamentals.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Orleans docs should exist [New article]: .NET Aspire and .NET Orleans
4 participants