Docs: Prerequisite Knowledge section #1821

markmandel · 2020-09-16T19:53:35Z

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:

Guide for learning the foundational knowledge of Agones, in case our users have some knowledge gaps they want/need to fill before digging into Agones itself.

Which issue(s) this PR fixes:

Closes #1759

Special notes for your reviewer:

I expect this will be a living doc that will evolve over time.

Closes #1759

agones-bot · 2020-09-16T20:12:49Z

Build Failed 😱

Build Id: 6a752c71-f64a-4ff9-8314-dadc67d83f39

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

site/content/en/docs/_index.md

aLekSer

Looks great, please fix 3 small nits.

site/content/en/docs/Prerequisite Knowledge/_index.md

roberthbailey · 2020-09-16T20:59:20Z

site/content/en/docs/Prerequisite Knowledge/_index.md

+
+* [Unity](https://unity.com/)
+* [Unreal](https://www.unrealengine.com/)
+


Maybe add a note here that we have a toy example game engine if you want to experiment with agones without having to build (or retrofit) a full game first.

In particular, most of our guides use the udp-server (now the simple-game-server) so saying here that you have to build using unity/unreal isn't aligned with working through the rest of our docs / guides.

I wasn't quite sure whether to link to engines here as well -- is that being an advocate of them over other engines?

But at the same time, if you've never used some kind of game engine they are probably the best place to learn about building a game in an engine.

We could link to the toy game engine/simple-game-server -- but does that let people learn about game engines? Probably not (which is kind of the point of this section).

..then I also wondered if we should point to multiplayer networking in a game engine (Unity might be more complicate than Unreal since most people I know doing production multiplayer Unity aren't using anything from Unity - they are using OSS or commerical tools).

So.... what do you think of that?

I wasn't quite sure whether to link to engines here as well -- is that being an advocate of them over other engines?

I think it's OK to link to these engines, since they are the ones that we have SDKs for. If we accrue SDKs for other engines, we should also add them to this list, since that means that they are popular enough that there is demand for a specific SDK.

We could link to the toy game engine/simple-game-server -- but does that let people learn about game engines? Probably not (which is kind of the point of this section).

I was thinking more along the lines of someone like myself. I've never really used unity or unreal, and I only have a surface level understanding of how they work. But I can use the simple game server to experiment with Agones (and develop it) without needing to first understand a complex game engine. If you are going to actually build and deploy a game then it makes sense to learn about game engines, but if you are just trying to kick the tires on Agones then understanding these isn't necessary.

We could link to the toy game engine/simple-game-server -- but does that let people learn about game engines? Probably not (which is kind of the point of this section).

It let's them learn about agones in isolation from a game engine, which is a lower bar. Even a game developer might want to start there - to make sure that agones is a good fit before investing the time in building any sort of game in a real engine.

..then I also wondered if we should point to multiplayer networking in a game engine (Unity might be more complicate than Unreal since most people I know doing production multiplayer Unity aren't using anything from Unity - they are using OSS or commercial tools).

Again, to me this is necessary to run a real game on agones, but not necessary to run something on agones. If we are talking about pre-reqs, then understanding dedicated game servers and why they exist seems a lot more important than game engines. You can get through all of the getting started guides without knowing anything about how an actual game engine works.

If you wanted to be impartial about game engines you could always link to something like https://en.wikipedia.org/wiki/List_of_game_engines.
I think it is beneficial to know which engines are tried and tested though.

You know - this makes me question whether we should have engines here at all.

@roberthbailey your point makes a lot of sense. You don't actually NEED to know how an engine works to use Agones. There's no point in learning how to do animations in Unity for example if you're only ever going to be working server side moving RPCs around.

Maybe this is an optional section? Or maybe even drop it at all?

Or maybe this should lean us more into fleshing out the "Dedicated Game Servers" section, and see what guides we can find for supported engines with SDKs?

I think it would be enough to change "If you are building a multiplayer game, having some knowledge of a game engine is a requirement" to "If you are building a multiplayer game, you will eventually need to understand how your game engine will integrate with Agones" (leaving the rest of the section alone) and also moving this section below "Dedicated Game Servers" which I think is more important. It wouldn't hurt to flush out the "Dedicated Game Servers" section more as well, but you already have some helpful links there so I don't think that should block this PR.

I like it. Done.

I also moved it below dedicated game servers, since it seemed to me that we should have the required stuff before we covered the more "nice to have eventually".

agones-bot · 2020-09-16T23:23:16Z

Build Succeeded 👏

Build Id: 48c64d6b-9148-434f-a89a-752d7bb4e80d

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

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

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

https://83247d7-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1821/head:pr_1821 && git checkout pr_1821
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.9.0-83247d7

roberthbailey · 2020-09-17T07:50:07Z

site/content/en/docs/_index.md

@@ -13,8 +13,11 @@ Release version: {{< release-version >}}

 These pages show you how to get up and running as quickly as possible in Agones.

-If you are new to Agones, start with [Installation]({{< relref "./Installation/_index.md" >}}), to get Agones
-up and running. 
+If you are new to Agones, start with [Overview]({{< relref "./Overview/_index.md" >}}), to get familiar with Agones'


nit: Extraneous comma after the overview link.

roberthbailey · 2020-09-17T07:50:19Z

site/content/en/docs/_index.md

+If you are new to Agones, start with [Overview]({{< relref "./Overview/_index.md" >}}), to get familiar with Agones'
+features and services.
+
+The [Installation]({{< relref "./Installation/_index.md" >}}) guide, will take you through creating a Kubernetes


Nit: Extraneous comma after guide

roberthbailey · 2020-09-17T07:51:16Z

site/content/en/docs/Overview/_index.md

 ## What Next?
+- Review our [Prerequisite Knowledge]({{% ref "/docs/Prerequisite Knowledge/_index.md" %}}). Especially if the above
+  sounds fantastic, but you aren't yet familiar with technology like Kubernetes, or terms such as "Game Servers".


nit: Extraneous comma after Kubernetes

roberthbailey · 2020-09-17T07:55:00Z

site/content/en/docs/Prerequisite Knowledge/_index.md

+
+### Resources
+
+* [You should totally read this comic, and interactive tutorial](https://cloud.google.com/kubernetes-engine/kubernetes-comic/)


Nit: Extraneous comma after comic

roberthbailey · 2020-09-17T08:03:03Z

site/content/en/docs/Prerequisite Knowledge/_index.md

+
+* [Unity](https://unity.com/)
+* [Unreal](https://www.unrealengine.com/)
+


I wasn't quite sure whether to link to engines here as well -- is that being an advocate of them over other engines?

I think it's OK to link to these engines, since they are the ones that we have SDKs for. If we accrue SDKs for other engines, we should also add them to this list, since that means that they are popular enough that there is demand for a specific SDK.

We could link to the toy game engine/simple-game-server -- but does that let people learn about game engines? Probably not (which is kind of the point of this section).

I was thinking more along the lines of someone like myself. I've never really used unity or unreal, and I only have a surface level understanding of how they work. But I can use the simple game server to experiment with Agones (and develop it) without needing to first understand a complex game engine. If you are going to actually build and deploy a game then it makes sense to learn about game engines, but if you are just trying to kick the tires on Agones then understanding these isn't necessary.

We could link to the toy game engine/simple-game-server -- but does that let people learn about game engines? Probably not (which is kind of the point of this section).

It let's them learn about agones in isolation from a game engine, which is a lower bar. Even a game developer might want to start there - to make sure that agones is a good fit before investing the time in building any sort of game in a real engine.

..then I also wondered if we should point to multiplayer networking in a game engine (Unity might be more complicate than Unreal since most people I know doing production multiplayer Unity aren't using anything from Unity - they are using OSS or commercial tools).

Again, to me this is necessary to run a real game on agones, but not necessary to run something on agones. If we are talking about pre-reqs, then understanding dedicated game servers and why they exist seems a lot more important than game engines. You can get through all of the getting started guides without knowing anything about how an actual game engine works.

Guide for learning the foundational knowledge of Agones, in case our users have some knowledge gaps they want/need to fill before digging into Agones itself. I expect this will be a living doc that will evolve over time. Closes googleforgames#1759

markmandel · 2020-10-13T23:41:19Z

Updated!

Looking forward to having this live - I think it's going to be useful 👍

agones-bot · 2020-10-13T23:57:22Z

Build Failed 😱

Build Id: 0a036166-7fed-4f29-b4ab-484496957e23

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

agones-bot · 2020-10-14T01:10:44Z

Build Succeeded 👏

Build Id: 70055f78-69dc-4b75-9a29-5a3168b47415

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1821/head:pr_1821 && git checkout pr_1821
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.10.0-f08335e

google-oss-robot · 2020-10-14T06:00:29Z

[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~~ [aLekSer,markmandel,roberthbailey]

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

* Docs: Prerequisite Knowledge section Guide for learning the foundational knowledge of Agones, in case our users have some knowledge gaps they want/need to fill before digging into Agones itself. I expect this will be a living doc that will evolve over time. Closes googleforgames#1759

markmandel added kind/feature New features for Agones kind/documentation Documentation for Agones labels Sep 16, 2020

google-oss-robot requested review from aLekSer and cyriltovena September 16, 2020 19:53

google-oss-robot added the approved label Sep 16, 2020

googlebot added the cla: yes label Sep 16, 2020

google-oss-robot added the size/M label Sep 16, 2020

aLekSer reviewed Sep 16, 2020

View reviewed changes

site/content/en/docs/_index.md Outdated Show resolved Hide resolved

aLekSer approved these changes Sep 16, 2020

View reviewed changes

google-oss-robot assigned aLekSer Sep 16, 2020

google-oss-robot added the lgtm label Sep 16, 2020

aLekSer reviewed Sep 16, 2020

View reviewed changes

site/content/en/docs/Prerequisite Knowledge/_index.md Outdated Show resolved Hide resolved

aLekSer reviewed Sep 16, 2020

View reviewed changes

site/content/en/docs/Prerequisite Knowledge/_index.md Outdated Show resolved Hide resolved

roberthbailey reviewed Sep 16, 2020

View reviewed changes

markmandel force-pushed the docs/prequisite branch from 325e3ab to 83247d7 Compare September 16, 2020 23:01

google-oss-robot removed the lgtm label Sep 16, 2020

roberthbailey reviewed Sep 21, 2020

View reviewed changes

markmandel added 3 commits October 13, 2020 16:40

Docs: Prerequisite Knowledge section

ff33489

Guide for learning the foundational knowledge of Agones, in case our users have some knowledge gaps they want/need to fill before digging into Agones itself. I expect this will be a living doc that will evolve over time. Closes googleforgames#1759

Review comments.

5134ddd

Second review.

f08335e

markmandel force-pushed the docs/prequisite branch from 83247d7 to f08335e Compare October 13, 2020 23:41

google-oss-robot added size/L and removed size/M labels Oct 13, 2020

domgreen mentioned this pull request Oct 14, 2020

Useful Unreal links #1846

Merged

roberthbailey approved these changes Oct 14, 2020

View reviewed changes

google-oss-robot assigned roberthbailey Oct 14, 2020

google-oss-robot added the lgtm label Oct 14, 2020

roberthbailey merged commit be1e6f5 into googleforgames:master Oct 14, 2020

markmandel added this to the 1.10.0 milestone Oct 14, 2020

markmandel deleted the docs/prequisite branch October 14, 2020 15:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Prerequisite Knowledge section #1821

Docs: Prerequisite Knowledge section #1821

markmandel commented Sep 16, 2020

agones-bot commented Sep 16, 2020

aLekSer left a comment •

edited

roberthbailey Sep 16, 2020

markmandel Sep 16, 2020

roberthbailey Sep 17, 2020

andrewgrundy Sep 17, 2020

markmandel Sep 29, 2020

roberthbailey Sep 29, 2020

markmandel Oct 13, 2020

agones-bot commented Sep 16, 2020

roberthbailey Sep 17, 2020

roberthbailey Sep 17, 2020

roberthbailey Sep 17, 2020

roberthbailey Sep 17, 2020

roberthbailey Sep 17, 2020

markmandel commented Oct 13, 2020

agones-bot commented Oct 13, 2020

agones-bot commented Oct 14, 2020

google-oss-robot commented Oct 14, 2020


		* [Unity](https://unity.com/)
		* [Unreal](https://www.unrealengine.com/)


		### Resources

		* [You should totally read this comic, and interactive tutorial](https://cloud.google.com/kubernetes-engine/kubernetes-comic/)

Docs: Prerequisite Knowledge section #1821

Docs: Prerequisite Knowledge section #1821

Conversation

markmandel commented Sep 16, 2020

agones-bot commented Sep 16, 2020

aLekSer left a comment • edited

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

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

agones-bot commented Sep 16, 2020

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

Choose a reason for hiding this comment

markmandel commented Oct 13, 2020

agones-bot commented Oct 13, 2020

agones-bot commented Oct 14, 2020

google-oss-robot commented Oct 14, 2020

aLekSer left a comment •

edited