Issue #1854: Fix getplayercount() description on index #1912

NomadicBits · 2020-11-29T12:15:18Z

What type of PR is this?

/kind documentation

What this PR does / Why we need it:

Fixes the documentation for getplayercount() on the index guide page to match the description for this function in the rest api. Current description is not for the getplayercount function

Which issue(s) this PR fixes:
Closes #1854

Special notes for your reviewer:
First PR for agones, let me know if it needs updating!

agones-bot · 2020-11-29T12:42:45Z

Build Succeeded 👏

Build Id: 633d399f-72c1-45de-b216-bb4617c1f278

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.11.0-8228776
image: gcr.io/agones-images/agones-sdk:1.11.0-8228776
image: gcr.io/agones-images/agones-ping:1.11.0-8228776
Linux C++ SDK (build): agonessdk-1.11.0-8228776-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.11.0-8228776.zip

A preview of the website (the last 30 builds are retained):

https://8228776-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1912/head:pr_1912 && git checkout pr_1912
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.11.0-8228776

markmandel · 2020-12-01T02:59:18Z

site/content/en/docs/Guides/Client SDKs/_index.md

-If `GameServer.Status.Players.IDs` is set manually through the Kubernetes API, use SDK.GameServer() 
-or SDK.WatchGameServer() instead to retrieve the current player count.
-{{< /alert >}}
+This function retrieves the current player count. 


Thanks for sending this through!

We should keep the note about "If GameServer.Status.Players.IDs is set manually through the Kubernetes API..." because it is still relevant (and important too 😄)

NomadicBits · 2020-12-02T02:24:26Z

Thanks! I tired to do a quick edit in the web ui and it didn't end up well. Revert that commit and went back to the ide.

It should have the alert back in. Let me know if you see anything more.

agones-bot · 2020-12-02T02:25:49Z

Build Succeeded 👏

Build Id: 599c4375-02e6-4112-89ba-85639edfe633

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.11.0-27cbaca
image: gcr.io/agones-images/agones-sdk:1.11.0-27cbaca
image: gcr.io/agones-images/agones-ping:1.11.0-27cbaca
Linux C++ SDK (build): agonessdk-1.11.0-27cbaca-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.11.0-27cbaca.zip

A preview of the website (the last 30 builds are retained):

https://27cbaca-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1912/head:pr_1912 && git checkout pr_1912
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.11.0-27cbaca

agones-bot · 2020-12-02T02:33:33Z

Build Succeeded 👏

Build Id: 4ad1028a-614c-4584-af2b-a4257732379a

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.11.0-8228776
image: gcr.io/agones-images/agones-sdk:1.11.0-8228776
image: gcr.io/agones-images/agones-ping:1.11.0-8228776
Linux C++ SDK (build): agonessdk-1.11.0-8228776-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.11.0-8228776.zip

A preview of the website (the last 30 builds are retained):

https://8228776-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1912/head:pr_1912 && git checkout pr_1912
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.11.0-8228776

agones-bot · 2020-12-02T02:44:22Z

Build Succeeded 👏

Build Id: 17718a59-b581-4237-a4da-01020aa2c700

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.11.0-3732745
image: gcr.io/agones-images/agones-sdk:1.11.0-3732745
image: gcr.io/agones-images/agones-ping:1.11.0-3732745
Linux C++ SDK (build): agonessdk-1.11.0-3732745-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.11.0-3732745.zip

A preview of the website (the last 30 builds are retained):

https://3732745-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1912/head:pr_1912 && git checkout pr_1912
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.11.0-3732745

markmandel

🐶 LGTM!

google-oss-robot · 2020-12-02T17:11:48Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bnwhorton, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

google-oss-robot · 2020-12-02T17:11:58Z

New changes are detected. LGTM label has been removed.

agones-bot · 2020-12-02T17:32:43Z

Build Succeeded 👏

Build Id: 47861e51-d2c8-4c40-8b23-5d469c3f8480

The following development artifacts have been built, and will exist for the next 30 days:

image: gcr.io/agones-images/agones-controller:1.11.0-f1747b5
image: gcr.io/agones-images/agones-sdk:1.11.0-f1747b5
image: gcr.io/agones-images/agones-ping:1.11.0-f1747b5
Linux C++ SDK (build): agonessdk-1.11.0-f1747b5-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.11.0-f1747b5.zip

A preview of the website (the last 30 builds are retained):

https://f1747b5-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1912/head:pr_1912 && git checkout pr_1912
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.11.0-f1747b5

Fix Getplayercount discription to match the rest api

8228776

google-oss-robot requested review from dzlier-gcp and roberthbailey November 29, 2020 12:15

google-cla bot added the cla: yes label Nov 29, 2020

google-oss-robot added the size/S label Nov 29, 2020

markmandel reviewed Dec 1, 2020

View reviewed changes

google-oss-robot added size/XS size/S and removed size/S size/XS labels Dec 2, 2020

Update Guides/ClientSDKS/index GetPlayerCount() add alert back in

3732745

google-oss-robot added size/XS and removed size/S labels Dec 2, 2020

markmandel approved these changes Dec 2, 2020

View reviewed changes

google-oss-robot assigned markmandel Dec 2, 2020

google-oss-robot added the lgtm label Dec 2, 2020

google-oss-robot added the approved label Dec 2, 2020

Merge branch 'master' into doucmentation/getplayercount

f1747b5

google-oss-robot removed the lgtm label Dec 2, 2020

markmandel merged commit 8cf7442 into googleforgames:master Dec 2, 2020

markmandel added kind/cleanup Refactoring code, fixing up documentation, etc kind/documentation Documentation for Agones labels Dec 2, 2020

markmandel added this to the 1.11.0 milestone Dec 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #1854: Fix getplayercount() description on index #1912

Issue #1854: Fix getplayercount() description on index #1912

NomadicBits commented Nov 29, 2020 •

edited

Loading

agones-bot commented Nov 29, 2020

markmandel Dec 1, 2020

NomadicBits commented Dec 2, 2020

agones-bot commented Dec 2, 2020

agones-bot commented Dec 2, 2020

agones-bot commented Dec 2, 2020

markmandel left a comment

google-oss-robot commented Dec 2, 2020

google-oss-robot commented Dec 2, 2020

agones-bot commented Dec 2, 2020

Issue #1854: Fix getplayercount() description on index #1912

Issue #1854: Fix getplayercount() description on index #1912

Conversation

NomadicBits commented Nov 29, 2020 • edited Loading

agones-bot commented Nov 29, 2020

markmandel Dec 1, 2020

Choose a reason for hiding this comment

NomadicBits commented Dec 2, 2020

agones-bot commented Dec 2, 2020

agones-bot commented Dec 2, 2020

agones-bot commented Dec 2, 2020

markmandel left a comment

Choose a reason for hiding this comment

google-oss-robot commented Dec 2, 2020

google-oss-robot commented Dec 2, 2020

agones-bot commented Dec 2, 2020

NomadicBits commented Nov 29, 2020 •

edited

Loading