Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Player Tracking SDK Reference #1564

Merged
merged 2 commits into from
May 18, 2020

Conversation

markmandel
Copy link
Collaborator

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature
/kind hotfix

What this PR does / Why we need it:

Reference for the general Player Tracking SDK API.

This included some slight reorganising, to make it less cluttered as we
add more functionality.

Which issue(s) this PR fixes:

Work on #1033

Special notes for your reviewer:
To come, is a full player tracking guide, and updates to the GameServer
reference.

@markmandel markmandel added kind/feature New features for Agones kind/documentation Documentation for Agones labels May 16, 2020
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 756deb48-a200-46e0-83aa-07fb30551b21

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:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1564/head:pr_1564 && git checkout pr_1564
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.6.0-773f473

@markmandel
Copy link
Collaborator Author

@markmandel markmandel requested review from aLekSer and roberthbailey and removed request for cyriltovena and EricFortin May 18, 2020 00:11
<p>The {{ $title }} feature is currently <strong><a href="{{ ref . "/docs/Guides/feature-stages.md#alpha" }}">Alpha</a></strong>,
not enabled by default, and may change in the future.</p>
<p>Use the Feature Gate <code>{{- $gate }}</code> to enable and test this feature.</p>
<p>See the <a href="{{ ref . "/docs/Guides/feature-stages.md#alpha" }}">Feature Gate documentation</a> for details on how to enable features.</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two links here go to the same place. I'm not sure that page actually helps me if I want to enable this feature gate (indicating that we might need some more documentation around that particular scenario).

Also, I noticed that player tracking isn't in the table at the top of that page: https://773f473-dot-preview-dot-agones-images.appspot.com/site/docs/guides/feature-stages/

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link might be more useful for the second case:
https://773f473-dot-preview-dot-agones-images.appspot.com/site/docs/guides/feature-stages/#feature-gates

Alpha and Beta features can be enabled or disabled through the agones.featureGates configuration option that can be found in the Helm configuration documentation.

Copy link
Collaborator Author

@markmandel markmandel May 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I noticed that player tracking isn't in the table at the top of that page: https://773f473-dot-preview-dot-agones-images.appspot.com/site/docs/guides/feature-stages/

That's the next PR. I have a Player Tracking actual guide that I wanted to link from there, but also wanted this page first to point to. This one seemed long enough on it's own to review.

The two links here go to the same place.

Ah! Good catch both of you. I think I meant that to go to #feature-gates and fumbled it. Making that change.

Reference for the general Player Tracking SDK API.

This included some slight reorganising, to make it less cluttered as we
add more functionality.

To come, is a full player tracking guide, and updates to the GameServer
reference.

Work on googleforgames#1033
@markmandel markmandel force-pushed the docs/tracking-ref branch from 773f473 to f71ef10 Compare May 18, 2020 16:42
@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 84fab3f2-2286-4809-adcb-612467f16336

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: c46fa7e1-e4e7-4c16-bd5b-80f3ba391959

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

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

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,roberthbailey]

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
Copy link

New changes are detected. LGTM label has been removed.

@markmandel markmandel added this to the 1.6.0 milestone May 18, 2020
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 49dff430-6acc-4ec3-b788-46864fd61978

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:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1564/head:pr_1564 && git checkout pr_1564
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.6.0-af2ec65

@markmandel markmandel merged commit d54490b into googleforgames:master May 18, 2020
@markmandel markmandel deleted the docs/tracking-ref branch May 18, 2020 22:10
ilkercelikyilmaz pushed a commit to ilkercelikyilmaz/agones that referenced this pull request Oct 23, 2020
Reference for the general Player Tracking SDK API.

This included some slight reorganising, to make it less cluttered as we
add more functionality.

To come, is a full player tracking guide, and updates to the GameServer
reference.

Work on googleforgames#1033
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved kind/documentation Documentation for Agones kind/feature New features for Agones size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants