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.

Sign up for GitHub

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

Jump to bottom

docs: added game server state diagram #475

Merged
merged 1 commit into from
Jan 10, 2019
Merged

docs: added game server state diagram #475

merged 1 commit into from
Jan 10, 2019

Conversation

jkowalski
Copy link
Contributor

No description provided.

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: d108730a-6b02-478c-8a2b-a4ea840fc226

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

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/475/head:pr_475 && git checkout pr_475
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.7.0-5795c4c

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 837ff99a-83fa-473c-b3e0-e30ae3a0923b

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

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/475/head:pr_475 && git checkout pr_475
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.8.0-e7ae864

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 6883216b-cfc4-4c14-b890-af793ba0d570

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

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/475/head:pr_475 && git checkout pr_475
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.7.0-bf96b07

markmandel
markmandel reviewed Jan 9, 2019
View reviewed changes
Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

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

Love this.

build/Makefile
@@ -296,6 +297,11 @@ gen-crd-client: $(ensure-build-image)
docker run --rm $(common_mounts) -w $(mount_path) $(build_tag) /root/gen-crd-client.sh
docker run --rm $(common_mounts) -w $(mount_path)/pkg $(build_tag) goimports -w .

doc-images: $(docs_path)/gameserver-states.png

%.png: %.dot
Copy link
Member

Choose a reason for hiding this comment

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

Do we want to put dot in the build image, so anyone can regenerate the diagram?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

dot (graphviz) was already there. Changed makefile to use it.

Copy link
Member

Choose a reason for hiding this comment

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

Fancy makefile usage! 👍

markmandel
markmandel reviewed Jan 9, 2019
View reviewed changes
docs/gameserver_spec.md
@@ -46,3 +46,15 @@ The `spec` field is the actual GameServer specification and it is composed as fo
- `protocol` the protocol being used. Defaults to UDP. TCP is the only other option.
- `health` to track the overall healthy state of the GameServer, more information available in the [health check documentation](./health_checking.md).
- `template` the [pod spec template](https://v1-10.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#podtemplatespec-v1-core) to run your GameServer containers, [see](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/#pod-templates) for more information.

## GameServer State Diagram
Copy link
Member

Choose a reason for hiding this comment

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

I feel like this should be it's own doc - maybe under reference? Or maybe part of the SDK integration? Not sure.

Here is feels a bit hidden?

Copy link
Member

Choose a reason for hiding this comment

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

Changed my mind - it's in the reference already, and we can rework it if need be in the new website (and I'll need to merge anyway), so let's get this in.

@markmandel markmandel added the kind/documentation Documentation for Agones label Jan 9, 2019
@markmandel markmandel added this to the 0.8.0 milestone Jan 9, 2019
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 6814b1ee-a13b-4b01-ae58-0a3b89b5b2d1

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

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/475/head:pr_475 && git checkout pr_475
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.7.0-62b786f

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 960a4a1b-f6f9-4f14-b92d-bbc1ad189a0a

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

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/475/head:pr_475 && git checkout pr_475
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.8.0-796e8e4

markmandel
markmandel approved these changes Jan 10, 2019
View reviewed changes
Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

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

LGTM

build/Makefile
@@ -296,6 +297,11 @@ gen-crd-client: $(ensure-build-image)
docker run --rm $(common_mounts) -w $(mount_path) $(build_tag) /root/gen-crd-client.sh
docker run --rm $(common_mounts) -w $(mount_path)/pkg $(build_tag) goimports -w .

doc-images: $(docs_path)/gameserver-states.png

%.png: %.dot
Copy link
Member

Choose a reason for hiding this comment

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

Fancy makefile usage! 👍

docs/gameserver_spec.md
@@ -46,3 +46,15 @@ The `spec` field is the actual GameServer specification and it is composed as fo
- `protocol` the protocol being used. Defaults to UDP. TCP is the only other option.
- `health` to track the overall healthy state of the GameServer, more information available in the [health check documentation](./health_checking.md).
- `template` the [pod spec template](https://v1-10.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#podtemplatespec-v1-core) to run your GameServer containers, [see](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/#pod-templates) for more information.

## GameServer State Diagram
Copy link
Member

Choose a reason for hiding this comment

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

Changed my mind - it's in the reference already, and we can rework it if need be in the new website (and I'll need to merge anyway), so let's get this in.

@markmandel markmandel merged commit c39f693 into googleforgames:master Jan 10, 2019
@jkowalski jkowalski mentioned this pull request Jan 29, 2019
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markmandel markmandel markmandel approved these changes

Assignees
No one assigned
Labels
kind/documentation Documentation for Agones
Projects
None yet
Milestone
0.8.0
Development

Successfully merging this pull request may close these issues.
3 participants
@jkowalski @agones-bot @markmandel