Counts and Lists: Improvements to SDK docs #3569
Merged
Conversation
This file contains 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
|
Build Succeeded 👏 Build Id: 5e7eac74-396e-48de-86d1-a70b0d580d42 The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
markmandel
force-pushed
the
docs/cl-sdl
branch
from
2d75efb to
c0d16e1
Compare
|
Build Succeeded 👏 Build Id: 2e85c120-524a-4ccf-b5cb-bcdcf572294d The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
igooch
requested changes
Jan 8, 2024
|
Build Succeeded 👏 Build Id: aef7dfa7-fafe-4a99-b3d0-be36cab1f630 The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
markmandel
force-pushed
the
docs/cl-sdl
branch
from
3cd1625 to
7d52c33
Compare
|
Didn't push the changes last week 🤦🏻 that should be better now. |
|
Build Succeeded 👏 Build Id: cea3619b-9428-4104-9fe9-18359710dde7 The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
igooch
approved these changes
Jan 24, 2024
Comment on lines
253
to
256
| In the event where a Counter or List may extend past the maximum capacity Allocation/API changes to | ||
| [`GameServer.status`]({{< ref "/docs/Reference/agones_crd_api_reference.html#agones.dev/v1.GameServerStatus" >}}) values | ||
| while a batched Counter or List modification operation has yet to be applied, those values will be silently truncated to | ||
| the capacity of that Counter or List. |
There was a problem hiding this comment.
This is still confusing. Subject -> Verb -> Object is an easier format to understand.
Suggested change
| In the event where a Counter or List may extend past the maximum capacity Allocation/API changes to | |
| [`GameServer.status`]({{< ref "/docs/Reference/agones_crd_api_reference.html#agones.dev/v1.GameServerStatus" >}}) values | |
| while a batched Counter or List modification operation has yet to be applied, those values will be silently truncated to | |
| the capacity of that Counter or List. | |
| The Agones SDK server batches the update operations of [`GameServer.Status.Counters` and `GameServer.Status.Lists`][gameserverstatus] asynchronously. This means that if you update [`GameServer.status`]({{< ref "/docs/Reference/agones_crd_api_reference.html#agones.dev/v1.GameServerStatus" >}}) values through both the SDK and the Allocation/Kubernetes API, the batch processing may silently truncate some of those values to the capacity of that Counter or List. |
There was a problem hiding this comment.
Thank you! That does read much better. Adding change and updating!
Much like the player tracking SDK documentation, I wanted to be explicit in the SDK documentation for Counts and Lists where data was being stored, and where default values where coming from with links back to the generated API reference - so made some improvements to help facilitate that. This does still need a Counters and Lists landing page to reference (this is my next task) as well, but wanted to get this done while I was thinking about it. Work on googleforgames#2716
markmandel
force-pushed
the
docs/cl-sdl
branch
from
7d52c33 to
469b560
Compare
|
Build Succeeded 👏 Build Id: 17183739-2283-4738-b019-d5a43797cb50 The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What type of PR is this?
/kind documentation
What this PR does / Why we need it:
Much like the player tracking SDK documentation, I wanted to be explicit in the SDK documentation for Counts and Lists where data was being stored, and where default values where coming from with links back to the generated API reference - so made some improvements to help facilitate that.
Which issue(s) this PR fixes:
Work on #2716
Special notes for your reviewer:
This does still need a Counters and Lists landing page to reference (this is my next task) as well, but wanted to get this done while I was thinking about it.