Skip to content

docs: modernize Orleans onboarding - #10331

Merged
ReubenBond merged 8 commits into
dotnet:mainfrom
ReubenBond:reubenbond-docs-modernize-orleans-10-onboarding
Aug 7, 2026
Merged

docs: modernize Orleans onboarding#10331
ReubenBond merged 8 commits into
dotnet:mainfrom
ReubenBond:reubenbond-docs-modernize-orleans-10-onboarding

Conversation

@ReubenBond

@ReubenBond ReubenBond commented Aug 2, 2026

Copy link
Copy Markdown
Member

Modernizes the Orleans onboarding and resource documentation around Orleans 10, with a single canonical beginner quickstart and current framework, provider, persistence, and scaling guidance.

Replaces version-pivoted and archival content with repository-backed samples and package references, removes duplicate legacy Hello World snippets, and adds compiling Azure provider snippets for the deployment quickstart.

Microsoft Reviewers: Open in CodeFlow

Copilot AI review requested due to automatic review settings August 2, 2026 16:11

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 PR modernizes the Orleans documentation onboarding flow for Orleans 10 by consolidating beginner guidance into a single canonical quickstart, removing legacy/duplicated tutorial content and version pivots, and updating resource pages to point at maintained, repository-backed samples.

Changes:

  • Replaces duplicated “minimal” and “Hello World” walkthroughs with links to the canonical “Build your first Orleans app” quickstart and the repo’s maintained HelloWorld sample.
  • Refreshes multiple “resources” and “conceptual” pages to reflect Orleans 10 guidance (packages, best practices, FAQ, architecture, benefits, links).
  • Adds updated Azure provider configuration snippets (Azure Table Storage + Cosmos DB for NoSQL) for the “Deploy and scale on Azure” quickstart.
Show a summary per file
File Description
docs/site/src/content/docs/tutorials-and-samples/tutorial-1.md Replaces the prior minimal tutorial with pointers to the canonical Orleans 10 quickstart/sample.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/Silo/Silo.csproj Removes legacy minimal tutorial snippet project.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/Silo/Program.cs Removes legacy minimal silo snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/minimal.sln Removes legacy minimal tutorial solution.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/Grains/HelloGrain.cs Removes legacy minimal grain snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/Grains/Grains.csproj Removes legacy minimal grains project snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/GrainInterfaces/IHello.cs Removes legacy minimal grain interface snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/GrainInterfaces/GrainInterfaces.csproj Removes legacy minimal grain interface project snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/Client/Program.cs Removes legacy minimal client snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/minimal/Client/Client.csproj Removes legacy minimal client project snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/helloworld/SiloProgram.cs Removes duplicated HelloWorld walkthrough snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/helloworld/IHello.cs Removes duplicated HelloWorld walkthrough snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/helloworld/helloworld.csproj Removes duplicated HelloWorld walkthrough snippet project.
docs/site/src/content/docs/tutorials-and-samples/snippets/helloworld/HelloGrain.cs Removes duplicated HelloWorld walkthrough snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets/helloworld/ClientProgram.cs Removes duplicated HelloWorld walkthrough snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets-v3/custom-storage/Program.cs Removes legacy v3 custom-storage snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets-v3/custom-storage/FileSiloBuilderExtensions.cs Removes legacy v3 custom-storage snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets-v3/custom-storage/FileGrainStorageOptions.cs Removes legacy v3 custom-storage snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets-v3/custom-storage/FileGrainStorageFactory.cs Removes legacy v3 custom-storage snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets-v3/custom-storage/FileGrainStorage.cs Removes legacy v3 custom-storage snippet.
docs/site/src/content/docs/tutorials-and-samples/snippets-v3/custom-storage/custom-storage.csproj Removes legacy v3 custom-storage snippet project.
docs/site/src/content/docs/tutorials-and-samples/overview-helloworld.md Replaces walkthrough content with links to the canonical quickstart and repo sample.
docs/site/src/content/docs/tutorials-and-samples/index.md Reworks the tutorials/samples index around quickstarts/tutorials/explanations and repo-backed sample catalog.
docs/site/src/content/docs/tutorials-and-samples/custom-grain-storage.md Drops legacy pivots and points at compiling end-to-end sample code.
docs/site/src/content/docs/tutorials-and-samples/adventure.md Updates the Adventure sample instructions to use the Orleans repo and README.
docs/site/src/content/docs/resources/student-projects.md Replaces outdated project lists with current contribution/discussion pointers.
docs/site/src/content/docs/resources/orleans-thinking-big-and-small.md Modernizes conceptual guidance on scale and operational concerns.
docs/site/src/content/docs/resources/orleans-architecture-principles-and-approach.md Updates architecture principles content to reflect Orleans 10 framing.
docs/site/src/content/docs/resources/nuget-packages.md Replaces version-pivoted package listings with Orleans 10-focused package guidance.
docs/site/src/content/docs/resources/links.md Curates/modernizes resources and guidance on where to get help/info.
docs/site/src/content/docs/resources/frequently-asked-questions.md Updates FAQs for Orleans 10 positioning, hosting, failures, and upgrade guidance.
docs/site/src/content/docs/resources/best-practices.md Rewrites best practices for Orleans 10 with a more structured “production readiness” perspective.
docs/site/src/content/docs/quickstarts/snippets/deploy-scale-orleans-on-azure/cosmos/Program.cs Adds Cosmos DB for NoSQL clustering + storage configuration snippet.
docs/site/src/content/docs/quickstarts/snippets/deploy-scale-orleans-on-azure/cosmos/Cosmos.csproj Adds a snippet project to support the Cosmos configuration snippet.
docs/site/src/content/docs/quickstarts/snippets/deploy-scale-orleans-on-azure/azure-storage/Program.cs Adds Azure Table Storage clustering + storage configuration snippet.
docs/site/src/content/docs/quickstarts/snippets/deploy-scale-orleans-on-azure/azure-storage/AzureStorage.csproj Adds a snippet project to support the Azure Storage configuration snippet.
docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md Updates the Azure deployment quickstart for Orleans 10 and references the new compiling snippets.
docs/site/src/content/docs/quickstarts/build-your-first-orleans-app.md Recasts the beginner quickstart as the canonical Orleans 10 onboarding path.
docs/site/src/content/docs/overview.md Removes version-pivoted overview content in favor of Orleans 10-focused conceptual framing.
docs/site/src/content/docs/index.yml Updates hub metadata and highlights the canonical beginner quickstart.
docs/site/src/content/docs/benefits.md Retitles/reframes “benefits” as “Why Orleans” with updated tradeoffs and guidance.

Copilot's findings

  • Files reviewed: 41/41 changed files
  • Comments generated: 2

Comment thread docs/site/src/content/docs/tutorials-and-samples/tutorial-1.md Outdated
Comment thread docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md Outdated
@ReubenBond ReubenBond changed the title docs: modernize Orleans 10 onboarding docs: modernize Orleans onboarding Aug 3, 2026
Copilot AI review requested due to automatic review settings August 3, 2026 17:23

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.

Copilot's findings

Suppressed comments (5)

docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:145

  • These commands use dotnet package add instead of the standard dotnet add package syntax, which is likely to fail for readers.
   dotnet package add Microsoft.Orleans.Clustering.AzureStorage
   dotnet package add Microsoft.Orleans.Persistence.AzureStorage

docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:155

  • This uses dotnet package add, but the .NET CLI command for adding a package is dotnet add package ....
   dotnet package add Azure.Identity

docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:167

  • These commands use dotnet package add instead of the standard dotnet add package syntax, which is likely to fail for readers.
   dotnet package add Microsoft.Orleans.Clustering.Cosmos
   dotnet package add Microsoft.Orleans.Persistence.Cosmos

docs/site/src/content/docs/quickstarts/build-your-first-orleans-app.md:33

  • dotnet package add is not the standard .NET CLI syntax for adding NuGet packages. The documented command is dotnet add package ..., so as written readers are likely to hit a CLI error.
dotnet package add Microsoft.Orleans.Server

docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:133

  • This uses dotnet package add, but the .NET CLI command for adding a package is dotnet add package .... Readers following these steps are likely to hit a CLI error.

This issue also appears in the following locations of the same file:

  • line 144
  • line 155
  • line 166
   dotnet package add Azure.Identity
  • Files reviewed: 41/41 changed files
  • Comments generated: 0 new

Copilot AI review requested due to automatic review settings August 5, 2026 13:18

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.

Copilot's findings

Suppressed comments (6)

docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:146

  • This code block uses dotnet package add, but other Orleans docs use dotnet add package. Aligning the syntax would keep the CLI guidance consistent across the docs set.
   ```dotnetcli
   dotnet package add Microsoft.Orleans.Clustering.AzureStorage
   dotnet package add Microsoft.Orleans.Persistence.AzureStorage
**docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:156**
* This code block uses `dotnet package add`, but other Orleans docs use `dotnet add package`. Aligning the syntax would keep the CLI guidance consistent across the docs set.
dotnet package add Azure.Identity
**docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:168**
* This code block uses `dotnet package add`, but other Orleans docs use `dotnet add package`. Aligning the syntax would keep the CLI guidance consistent across the docs set.
dotnet package add Microsoft.Orleans.Clustering.Cosmos
dotnet package add Microsoft.Orleans.Persistence.Cosmos
**docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:91**
* In the Azure Table Storage pivot, this step says setting DEPLOY_AZURE_TABLE_STORAGE enables deployment of Azure Cosmos DB for NoSQL. That contradicts the variable name and the surrounding pivot; it should refer to Azure Table Storage.
  1. Using the terminal, run azd env set to configure the DEPLOY_AZURE_TABLE_STORAGE environment variable to enable deployment of Azure Cosmos DB for NoSQL.
**docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md:134**
* This quickstart uses `dotnet package add`, but the rest of the Orleans docs consistently use `dotnet add package` (for example, docs/site/src/content/docs/host/configuration-guide/local-development-configuration.md:49). Consider aligning the command syntax here for consistency and to avoid reader confusion.

This issue also appears in the following locations of the same file:
- line 143
- line 154
- line 165
dotnet package add Azure.Identity
**docs/site/src/content/docs/quickstarts/build-your-first-orleans-app.md:33**
* This snippet uses `dotnet package add`, but other Orleans docs consistently use `dotnet add package` (for example, docs/site/src/content/docs/host/configuration-guide/local-development-configuration.md:49). Aligning the command syntax here would avoid confusing readers.

dotnet package add Microsoft.Orleans.Server

</details>


- **Files reviewed:** 41/41 changed files
- **Comments generated:** 0 new

ReubenBond added a commit to ReubenBond/orleans that referenced this pull request Aug 5, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9be838b5-7660-444e-b2c5-bf2e9b373472
@ReubenBond
ReubenBond force-pushed the reubenbond-docs-modernize-orleans-10-onboarding branch from a48a6a9 to f6b9250 Compare August 7, 2026 15:51
ReubenBond added a commit to ReubenBond/orleans that referenced this pull request Aug 7, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9be838b5-7660-444e-b2c5-bf2e9b373472

# Conflicts:
#	docs/site/src/content/docs/index.yml
#	docs/site/src/content/docs/quickstarts/deploy-scale-orleans-on-azure.md
@ReubenBond
ReubenBond force-pushed the reubenbond-docs-modernize-orleans-10-onboarding branch from 2b80484 to 80c43ce Compare August 7, 2026 17:55
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d3ece89b-eb32-4f23-8fcc-60a6007f48ca
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d3ece89b-eb32-4f23-8fcc-60a6007f48ca
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d3ece89b-eb32-4f23-8fcc-60a6007f48ca
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d3ece89b-eb32-4f23-8fcc-60a6007f48ca
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d3ece89b-eb32-4f23-8fcc-60a6007f48ca
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d3ece89b-eb32-4f23-8fcc-60a6007f48ca
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d3ece89b-eb32-4f23-8fcc-60a6007f48ca
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d3ece89b-eb32-4f23-8fcc-60a6007f48ca
@ReubenBond
ReubenBond force-pushed the reubenbond-docs-modernize-orleans-10-onboarding branch from 24b2396 to 816fa8c Compare August 7, 2026 19:56
@ReubenBond
ReubenBond merged commit b0b318e into dotnet:main Aug 7, 2026
66 of 67 checks passed
@ReubenBond
ReubenBond deleted the reubenbond-docs-modernize-orleans-10-onboarding branch August 7, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants