Skip to content

Commit

Permalink
docs: consistency of counter and list comments between example and re…
Browse files Browse the repository at this point in the history
…ference files

Also includes some tidying up of comments
  • Loading branch information
yonbh committed May 14, 2024
1 parent a5a351b commit 1716e09
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
11 changes: 8 additions & 3 deletions examples/fleet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,18 @@ spec:
annotations:
otherkey: setthisvalue
#
# [Stage:Alpha]
# [Stage:Beta]
# [FeatureFlag:CountsAndLists]
# Which gameservers in the Fleet are most important to keep around - impacts scale down logic.
# Priority of sorting is in descending importance. I.e. The position 0 `priority` entry is checked first.
# Now in Beta, and enabled by default
# priorities:
# - type: Counter # Whether a Counter or a List.
# key: rooms # The name of the Counter or List.
# order: Ascending # Default is "Ascending" so smaller capacity will be removed first on down scaling.
# key: sessions # The name of the Counter or List. No impact if no GameServer found.
# order: Ascending # Default is "Ascending" so smaller available capacity will be removed first on down scaling.
# - type: List
# key: players
# order: Ascending
#
template:
# GameServer metadata
Expand Down
14 changes: 8 additions & 6 deletions site/content/en/docs/Reference/fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,18 @@ spec:
annotations:
otherkey: setthisvalue
#
# [Stage:Alpha]
# [Stage:Beta]
# [FeatureFlag:CountsAndLists]
# Which gameservers in the Fleet are most important to keep around - impacts scale down logic.
# Priority of sorting is in descending importance. I.e. The position 0 `priority` entry is checked first.
# Now in Beta, and enabled by default
# priorities:
# - type: Counter # Sort by a “Counter
# key: rooms # The name of the Counter. No impact if no GameServer found.
# - type: Counter # Whether a Counter or a List.
# key: rooms # The name of the Counter or List. No impact if no GameServer found.
# order: Descending # Default is "Ascending" so smaller available capacity will be removed first on down scaling.
# - type: List # Sort by a “List”
# key: players # The name of the List. No impact if no GameServer found.
# order: Ascending # Default is "Ascending" so smaller available capacity will be removed first on down scaling.
# - type: List
# key: players
# order: Ascending
#
template:
# GameServer metadata
Expand Down

0 comments on commit 1716e09

Please sign in to comment.