docs: add scheduling strategy documentation for Region API#195
Open
Hauke Löffler (hloeffler) wants to merge 16 commits intomainfrom
Open
docs: add scheduling strategy documentation for Region API#195Hauke Löffler (hloeffler) wants to merge 16 commits intomainfrom
Hauke Löffler (hloeffler) wants to merge 16 commits intomainfrom
Conversation
Copilot started reviewing on behalf of
Hauke Löffler (hloeffler)
January 15, 2026 11:34
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the scheduling strategy feature, which allows API users to configure how GameServers are distributed across Kubernetes nodes for Region Types. The feature supports Packed and Distributed strategies, with Packed as the default.
Changes:
- Adds a new dedicated page documenting the scheduling strategy configuration for the Region API
- Updates the API sidebar to include a link to the new scheduling strategy page
- Adds a Region creation example to the API examples page demonstrating the scheduling field usage
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/multiplayer-servers/api/scheduling-strategy.md |
New documentation page explaining scheduling strategy options, usage, and best practices |
src/multiplayer-servers/api/sidebar.json |
Added sidebar navigation entry for the new scheduling strategy page |
src/multiplayer-servers/api/examples.md |
Added Region creation example demonstrating the scheduling field with cross-reference to detailed documentation |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Hauke Löffler (hloeffler)
February 9, 2026 10:26
View session
Co-authored-by: Brendan Le Glaunec <brendan@glaulabs.com>
Co-authored-by: Brendan Le Glaunec <brendan@glaulabs.com>
Co-authored-by: Brendan Le Glaunec <brendan@glaulabs.com>
Co-authored-by: Brendan Le Glaunec <brendan@glaulabs.com>
Co-authored-by: Brendan Le Glaunec <brendan@glaulabs.com>
…trategy - Simplify 'Kubernetes nodes' to 'nodes' for consistency - Remove 'UI support planned' from warning box - Clarify that scheduling applies to both Armadas and Vessels - Fix code block language identifier (json) - Improve example headings and introductory sentences - Rewrite use case lists per writing guidelines - Add Scheduling Strategy entry to glossary - Add links to Region API reference
Copilot started reviewing on behalf of
Hauke Löffler (hloeffler)
February 9, 2026 10:44
View session
- Use 'on-premises' consistently (was 'on-prem' in table) - Replace ellipsis with clear placeholder in JSON snippet - Change examples.md to use Distributed strategy (demonstrates customization)
Copilot started reviewing on behalf of
Hauke Löffler (hloeffler)
February 9, 2026 10:52
View session
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Hauke Löffler (hloeffler)
February 16, 2026 11:39
View session
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Brendan Le Glaunec (Ullaakut)
approved these changes
Feb 16, 2026
Alex Bartolomey (zoomoid)
requested changes
Feb 16, 2026
- Rewrite table descriptions per zoomoid feedback (no 'Bin-packs') - Use 'game servers' (lowercase) consistently - Fix placeholder to show valid value - Use Distributed in full example to demonstrate customization
Copilot started reviewing on behalf of
Hauke Löffler (hloeffler)
February 18, 2026 10:44
View session
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Hauke Löffler (hloeffler)
February 18, 2026 12:57
View session
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PackedandDistributedscheduling options for Region TypesChanges
src/multiplayer-servers/api/scheduling-strategy.mdsrc/multiplayer-servers/api/sidebar.jsonsrc/multiplayer-servers/api/examples.mdNotes
Verification
yarn docs:build)