Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 13, 2025

Summary

The multi-clustering feature was removed in Orleans 2.x. This PR removes all related documentation and adds redirections for the deleted pages to prevent broken links.

Fixes #49490

Changes

  • Deleted docs/orleans/deployment/multi-cluster-support/ directory and all 5 documentation files within it
  • Removed multi-cluster support section from toc.yml deployment navigation
  • Removed multi-cluster deployment link from index.yml hub page
  • Removed MultiClusterOptions reference from options classes documentation
  • Updated replicated-instances.md to remove obsolete OneInstancePerClusterAttribute reference while preserving general replicated instances documentation
  • Added 5 redirections in .openpublishing.redirection.orleans.json to redirect all deleted pages to /dotnet/orleans/deployment/ to prevent 404 errors

Total: 363 lines removed, 1 line modified, 20 lines added for redirections.

Original prompt

This section details on the original issue you should resolve

<issue_title>Orleans: remove multi-clustering docs</issue_title>
<issue_description>### Describe the issue or suggestion

The multi-clustering feature was removed in Orleans 2.x (long ago), and the documentation adds more confusion than clarity at this point.

Remove all docs under docs/orleans/deployment/multi-cluster-support and clean up the index/toc and any other docs which refer to Global single-instance or multi-clustering</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/orleans/grains/event-sourcing/replicated-instances.md docs/orleans/grains/event-sourcing/replicated-instances
docs/orleans/host/configuration-guide/list-of-options-classes.md docs/orleans/host/configuration-guide/list-of-options-classes
docs/orleans/index.yml docs/orleans/index
docs/orleans/toc.yml docs/orleans/toc

Co-authored-by: ReubenBond <203839+ReubenBond@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove multi-clustering documentation from Orleans Remove Orleans multi-clustering documentation Nov 13, 2025
Copilot AI requested a review from ReubenBond November 13, 2025 22:47
Copilot finished work on behalf of ReubenBond November 13, 2025 22:47
@ReubenBond
Copy link
Member

@copilot there are some errors:

Error: No redirection is found for 'docs/orleans/deployment/multi-cluster-support/global-single-instance.md'.
Error: No redirection is found for 'docs/orleans/deployment/multi-cluster-support/gossip-channels.md'.
Error: No redirection is found for 'docs/orleans/deployment/multi-cluster-support/multi-cluster-configuration.md'.
Error: No redirection is found for 'docs/orleans/deployment/multi-cluster-support/overview.md'.
Error: No redirection is found for 'docs/orleans/deployment/multi-cluster-support/silo-configuration.md'.

Perhaps we should redirect these to the index.

Co-authored-by: ReubenBond <203839+ReubenBond@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Nov 14, 2025

@copilot there are some errors:

Error: No redirection is found for 'docs/orleans/deployment/multi-cluster-support/global-single-instance.md'.
...

Added redirections for all 5 deleted pages to redirect to /dotnet/orleans/deployment/ in commit def55fc.

Copilot finished work on behalf of ReubenBond November 14, 2025 15:03
Copilot AI requested a review from ReubenBond November 14, 2025 15:03
@ReubenBond ReubenBond marked this pull request as ready for review November 14, 2025 16:03
Copilot AI review requested due to automatic review settings November 14, 2025 16:03
@ReubenBond ReubenBond requested a review from a team as a code owner November 14, 2025 16:03
Copilot finished reviewing on behalf of ReubenBond November 14, 2025 16:05
Copy link
Contributor

Copilot AI left a 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 removes all documentation related to Orleans multi-clustering, a feature that was removed in Orleans 2.x. The changes clean up outdated references and add redirections to prevent broken links.

Key changes:

  • Deleted the entire multi-cluster-support directory containing 5 documentation files
  • Removed all references to multi-cluster features from navigation files and documentation
  • Added 5 redirections to prevent 404 errors for deleted pages

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/orleans/toc.yml Removed multi-cluster support section from deployment navigation
docs/orleans/index.yml Removed multi-cluster deployment link from hub page
docs/orleans/host/configuration-guide/list-of-options-classes.md Removed MultiClusterOptions from options classes table
docs/orleans/grains/event-sourcing/replicated-instances.md Removed reference to OneInstancePerClusterAttribute while preserving general replicated instances documentation
docs/orleans/deployment/multi-cluster-support/silo-configuration.md Deleted file documenting silo configuration for multi-cluster support
docs/orleans/deployment/multi-cluster-support/overview.md Deleted overview file for multi-cluster support
docs/orleans/deployment/multi-cluster-support/multi-cluster-configuration.md Deleted file documenting multi-cluster configuration
docs/orleans/deployment/multi-cluster-support/gossip-channels.md Deleted file documenting multi-cluster communication
docs/orleans/deployment/multi-cluster-support/global-single-instance.md Deleted file documenting global single-instance grains
.openpublishing.redirection.orleans.json Added 5 redirections for deleted multi-cluster documentation pages

@gewarren gewarren merged commit 9c723a1 into main Nov 14, 2025
19 checks passed
@gewarren gewarren deleted the copilot/remove-multi-cluster-docs branch November 14, 2025 18:07
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.

Orleans: remove multi-clustering docs

3 participants