Docs: Fix using GOPATH in the guides, added shortcode ghrelease #1165

aLekSer · 2019-10-30T14:45:38Z

Switch from local path to github link.
Added shortcode ghrelease which added a link to download zip file.
Closes #1151.

agones-bot · 2019-10-30T15:00:22Z

Build Succeeded 👏

Build Id: f7b889e9-5430-4fea-9769-183353367ac2

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

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

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

https://16ef330-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-16ef330

roberthbailey · 2019-10-30T15:35:55Z

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

@@ -94,3 +95,5 @@ $ curl -X PUT "http://localhost:59358/metadata/label" -H "accept: application/js
 $ curl -GET "http://localhost:59358/gameserver" -H "accept: application/json"}"
 {"object_meta":{"creation_timestamp":"-62135596800","labels":{"agones.dev/sdk-foo":"bar"}},"spec":{"health":{}},"status":{"state":"Ready"}}
 ```
+
+It is assumed that you have downloaded and unzipped SDK server binary according to your OS type (in this example sdk-server.linux.amd64).


I'm not clear on why this is at the very bottom of the page (or here at all). At the top of the page it talks about downloading the sdkserver and also using it, so presumably if you got this far you already know that downloading is required.

Yes, I thought of someone who would read from the middle. However this might be obvious, so I will remove this section.

Fixed this and lines above, used {{< release-version >}}

agones-bot · 2019-10-30T17:48:04Z

Build Succeeded 👏

Build Id: 2f317173-3a2c-4a65-bc46-a43b87826d5a

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

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

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

https://0eba665-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-0eba665

aLekSer · 2019-10-30T18:50:51Z

Also update log output to be consistent with what we have now

agones-bot · 2019-10-30T19:04:03Z

Build Succeeded 👏

Build Id: 95a4a047-5121-40c1-8929-a8f6c8c52faa

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

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

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

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

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-cc1153e

roberthbailey · 2019-10-30T19:14:48Z

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

 that you can see exactly what the SDK in your game server is doing, and can
 confirm everything works.

-To do this you will need to download the latest agonessdk-server-{VERSION}.zip from 
+To do this you will need to download the latest `agonessdk-server-{{< release-version >}}.zip` from


Should this be release-branch instead of release-version? Right now the rendered site replaces this with 1.2.0 and the github links with "master" (which I assume will change the 1.1.0 once this publishes). They should both point to 1.1.0 since that is the latest release.

According as of release PR to https://github.com/googleforgames/agones/pull/1161/files:

release_branch = "release-1.1.0" release_version = "1.1.0"

File is agonessdk-server-1.1.0.zip.
master is set as ENV variable in includes/website.mk.
I will try to deploy this and attach it here.

roberthbailey · 2019-10-30T19:15:09Z

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

 that you can see exactly what the SDK in your game server is doing, and can
 confirm everything works.

-To do this you will need to download the latest agonessdk-server-{VERSION}.zip from 
+To do this you will need to download the latest `agonessdk-server-{{< release-version >}}.zip` from


nit: remove "the latest" since this will now point to a specific zip file name.

roberthbailey · 2019-10-30T19:16:09Z

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

 that you can see exactly what the SDK in your game server is doing, and can
 confirm everything works.

-To do this you will need to download the latest agonessdk-server-{VERSION}.zip from 
+To do this you will need to download the latest `agonessdk-server-{{< release-version >}}.zip` from
 [releases](https://github.com/googleforgames/agones/releases), and unzip it.


Can we point to the specific release instead of making users find it on this page?

Maybe something like https://github.com/googleforgames/agones/releases/tag/v{{< release-branch >}}?

Yes that would be definitely a better solution.

agones-bot · 2019-10-31T15:43:52Z

Build Failed 😱

Build Id: 9f2cc6a6-ad18-426f-858b-13d9e4dd9472

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

aLekSer · 2019-10-31T19:45:07Z

With this version make site-test fails with:

Non-OK status: 404 --- site/docs/guides/client-sdks/local/index.html --> https://github.com/googleforgames/agones/releases/download/v1.2.0/agonessdk-server-1.2.0.zip
Step #16 - "tests":

Need some enhanced way to keep reference checks calm.

roberthbailey · 2019-10-31T19:51:05Z

There's a data-proofer attribute you can add to links to make tests pass even if the links don't yet resolve.

agones-bot · 2019-10-31T20:10:17Z

Build Succeeded 👏

Build Id: f53d081e-c408-489c-a335-0347e514c8ac

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

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

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

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

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-d5ab49f

agones-bot · 2019-10-31T20:15:19Z

Build Succeeded 👏

Build Id: 1a4e1ca4-f316-43d9-a68d-2953b34f6178

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

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

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

https://740d70b-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-740d70b

markmandel · 2019-10-31T20:39:56Z

Not sure it's useful here, but we have a github link shortcode:
https://github.com/googleforgames/agones/blob/master/site/layouts/shortcodes/ghlink.html

But I think you are mostly pointing at raw/releases, so probably not so useful.

aLekSer · 2019-11-01T10:06:56Z

Thanks for the comments, I have joined both suggestions and the result was introducing a new shortcode ghrelease which would make a proper <a> tag with data-proofer-ignore in it.

agones-bot · 2019-11-01T10:19:47Z

Build Succeeded 👏

Build Id: 2078e6aa-d9ad-4941-8b50-4e3dba25f9b6

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

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

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

https://5aed24f-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-5aed24f

agones-bot · 2019-11-01T10:41:45Z

Build Succeeded 👏

Build Id: a51c0ea3-ab74-4976-865a-8c7add66b855

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

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

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

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

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-cd88dd1

roberthbailey · 2019-11-04T05:48:20Z

/assign @markmandel

Mark - can you take a quick glance (since you are more of an expert on the website) and merge if you are comfortable with the change?

agones-bot · 2019-11-04T06:14:48Z

Build Succeeded 👏

Build Id: 2f927657-f70f-4095-8bf9-6a97b6283d8b

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

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

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

https://4a6902d-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-4a6902d

markmandel · 2019-11-04T19:31:51Z

site/layouts/shortcodes/ghrelease.html

@@ -0,0 +1 @@
+<a href="{{$.Page.Site.Params.github_repo}}/releases/download/v{{$.Page.Site.Params.release_version}}/{{ .Get 0 }}-{{$.Page.Site.Params.release_version}}.zip" data-proofer-ignore >{{ .Get 0 }}-{{$.Page.Site.Params.release_version}}.zip</a>


Should this always be data-proofer-ignore ? I would think this should be an optional attribute, like ghlink has.

We will want this link tested long term.

That's correct. I thought of the situation when we don't created release archives, but have updated the version. I will update this PR.

Resolved an issue, resulting make site-server web page contains future version:

<a href="https://github.com/googleforgames/agones/releases/download/v1.2.0/agonessdk-server-1.2.0.zip" data-proofer-ignore="">agonessdk-server-1.2.0.zip</a>

agones-bot · 2019-11-05T14:38:56Z

Build Failed 😱

Build Id: 60b536c7-59c2-47b5-a35b-c7182db71b4c

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

aLekSer · 2019-11-05T14:41:30Z

@markmandel Something went wrong with formatting:


Step #21: time="2019-11-05 14:34:37.885" level=info msg="sending message" fields.msg=CRASH gs=udp-serverc77fb state=Scheduled test=TestGameServerRestartBeforeReadyCrash
...
Step #21: time="2019-11-05 14:35:16.957" level=info msg="sending message" fields.msg=CRASH gs=udp-serverc77fb state=Scheduled test=TestGameServerRestartBeforeReadyCrash
...
Step #21: time="2019-11-05 14:35:47.960" level=info msg="sending message" fields.msg=READY gs=udp-serverc77fb state=Scheduled test=TestGameServerRestartBeforeReadyCrash
....
Step #21: time="2019-11-05 14:38:47.970" level=info msg="sending message" fields.msg=READY gs=udp-serverc77fb state=Unhealthy test=TestGameServerRestartBeforeReadyCrash
Step #21: time="2019-11-05 14:38:47.979" level=info msg="sending message" fields.msg=READY gs=udp-serverc77fb state=Unhealthy test=TestGameServerRestartBeforeReadyCrash
Step #21: --- FAIL: TestGameServerRestartBeforeReadyCrash (271.91s)
Step #21: gameserver_test.go:304:
Step #21: Error Trace: gameserver_test.go:304
Step #21: Error: Could not make GameServer Ready: %v
Step #21: Test: TestGameServerRestartBeforeReadyCrash
Step #21: Messages: timed out waiting for the condition
Step #21: FAIL

func FailNowf(t TestingT, failureMessage string, msg string, args ...interface{}) bool
Could be something like:

assert.FailNowf(t, "Could not make GameServer Ready", "Error description: %v", err.Error())

Add ghrelase shotcode which uses one param - file prefix. Switch from local path to github link. Closes googleforgames#1151.

agones-bot · 2019-11-05T15:25:49Z

Build Succeeded 👏

Build Id: 306e8692-c340-4908-9238-9678b05a25e2

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

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

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

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

To install this version:

git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1165/head:pr_1165 && git checkout pr_1165
helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.2.0-ab4e1d0

markmandel

LGTM!

google-oss-robot · 2019-11-05T19:12:19Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aLekSer, 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

Add ghrelase shotcode which uses one param - file prefix. Switch from local path to github link. Closes googleforgames#1151.

google-oss-robot requested review from cyriltovena and joeholley October 30, 2019 14:45

google-oss-robot added the size/S label Oct 30, 2019

aLekSer changed the title ~~Fix using GOPATH in the guides~~ Docs: Fix using GOPATH in the guides Oct 30, 2019

roberthbailey reviewed Oct 30, 2019

View reviewed changes

aLekSer force-pushed the docs/fix-local-paths branch from 16ef330 to 0eba665 Compare October 30, 2019 17:33

aLekSer force-pushed the docs/fix-local-paths branch from 0eba665 to cc1153e Compare October 30, 2019 18:50

google-oss-robot added size/M and removed size/S labels Oct 30, 2019

roberthbailey reviewed Oct 30, 2019

View reviewed changes

aLekSer force-pushed the docs/fix-local-paths branch from cc1153e to c304c53 Compare October 31, 2019 15:34

aLekSer force-pushed the docs/fix-local-paths branch 2 times, most recently from d5ab49f to 740d70b Compare October 31, 2019 19:57

aLekSer force-pushed the docs/fix-local-paths branch from 740d70b to 5aed24f Compare November 1, 2019 10:04

aLekSer changed the title ~~Docs: Fix using GOPATH in the guides~~ Docs: Fix using GOPATH in the guides, added shortcode ghreleases Nov 1, 2019

aLekSer changed the title ~~Docs: Fix using GOPATH in the guides, added shortcode ghreleases~~ Docs: Fix using GOPATH in the guides, added shortcode ghrelease Nov 1, 2019

aLekSer force-pushed the docs/fix-local-paths branch from 5aed24f to cd88dd1 Compare November 1, 2019 10:27

roberthbailey self-assigned this Nov 4, 2019

roberthbailey approved these changes Nov 4, 2019

View reviewed changes

google-oss-robot added lgtm approved labels Nov 4, 2019

google-oss-robot assigned markmandel Nov 4, 2019

markmandel requested changes Nov 4, 2019

View reviewed changes

google-oss-robot removed the lgtm label Nov 4, 2019

aLekSer force-pushed the docs/fix-local-paths branch from 4a6902d to 1dd1c77 Compare November 5, 2019 14:24

Fix using GOPATH in the guides

ab4e1d0

Add ghrelase shotcode which uses one param - file prefix. Switch from local path to github link. Closes googleforgames#1151.

aLekSer force-pushed the docs/fix-local-paths branch from 1dd1c77 to ab4e1d0 Compare November 5, 2019 15:09

markmandel approved these changes Nov 5, 2019

View reviewed changes

google-oss-robot added the lgtm label Nov 5, 2019

markmandel merged commit 5a1b769 into googleforgames:master Nov 5, 2019

roberthbailey added this to the 1.2.0 milestone Nov 8, 2019

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

ilkercelikyilmaz pushed a commit to ilkercelikyilmaz/agones that referenced this pull request Oct 23, 2020

Fix using GOPATH in the guides (googleforgames#1165)

0cd280b

Add ghrelase shotcode which uses one param - file prefix. Switch from local path to github link. Closes googleforgames#1151.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Fix using GOPATH in the guides, added shortcode ghrelease #1165

Docs: Fix using GOPATH in the guides, added shortcode ghrelease #1165

aLekSer commented Oct 30, 2019 •

edited

Loading

agones-bot commented Oct 30, 2019

roberthbailey Oct 30, 2019

aLekSer Oct 30, 2019 •

edited

Loading

aLekSer Oct 30, 2019

agones-bot commented Oct 30, 2019

aLekSer commented Oct 30, 2019

agones-bot commented Oct 30, 2019

roberthbailey Oct 30, 2019

aLekSer Oct 31, 2019

roberthbailey Oct 30, 2019

roberthbailey Oct 30, 2019

aLekSer Oct 31, 2019 •

edited

Loading

agones-bot commented Oct 31, 2019

aLekSer commented Oct 31, 2019

roberthbailey commented Oct 31, 2019

agones-bot commented Oct 31, 2019

agones-bot commented Oct 31, 2019

markmandel commented Oct 31, 2019

aLekSer commented Nov 1, 2019 •

edited

Loading

agones-bot commented Nov 1, 2019

agones-bot commented Nov 1, 2019

roberthbailey commented Nov 4, 2019

agones-bot commented Nov 4, 2019

markmandel Nov 4, 2019

aLekSer Nov 5, 2019

aLekSer Nov 5, 2019 •

edited

Loading

agones-bot commented Nov 5, 2019

aLekSer commented Nov 5, 2019 •

edited

Loading

agones-bot commented Nov 5, 2019

markmandel left a comment

google-oss-robot commented Nov 5, 2019

		@@ -0,0 +1 @@
		<a href="{{$.Page.Site.Params.github_repo}}/releases/download/v{{$.Page.Site.Params.release_version}}/{{ .Get 0 }}-{{$.Page.Site.Params.release_version}}.zip" data-proofer-ignore >{{ .Get 0 }}-{{$.Page.Site.Params.release_version}}.zip</a>

Docs: Fix using GOPATH in the guides, added shortcode ghrelease #1165

Docs: Fix using GOPATH in the guides, added shortcode ghrelease #1165

Conversation

aLekSer commented Oct 30, 2019 • edited Loading

agones-bot commented Oct 30, 2019

Choose a reason for hiding this comment

aLekSer Oct 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Oct 30, 2019

aLekSer commented Oct 30, 2019

agones-bot commented Oct 30, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aLekSer Oct 31, 2019 • edited Loading

Choose a reason for hiding this comment

agones-bot commented Oct 31, 2019

aLekSer commented Oct 31, 2019

roberthbailey commented Oct 31, 2019

agones-bot commented Oct 31, 2019

agones-bot commented Oct 31, 2019

markmandel commented Oct 31, 2019

aLekSer commented Nov 1, 2019 • edited Loading

agones-bot commented Nov 1, 2019

agones-bot commented Nov 1, 2019

roberthbailey commented Nov 4, 2019

agones-bot commented Nov 4, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aLekSer Nov 5, 2019 • edited Loading

Choose a reason for hiding this comment

agones-bot commented Nov 5, 2019

aLekSer commented Nov 5, 2019 • edited Loading

agones-bot commented Nov 5, 2019

markmandel left a comment

Choose a reason for hiding this comment

google-oss-robot commented Nov 5, 2019

aLekSer commented Oct 30, 2019 •

edited

Loading

aLekSer Oct 30, 2019 •

edited

Loading

aLekSer Oct 31, 2019 •

edited

Loading

aLekSer commented Nov 1, 2019 •

edited

Loading

aLekSer Nov 5, 2019 •

edited

Loading

aLekSer commented Nov 5, 2019 •

edited

Loading