From 4bb2cc020e4e4e694e2c24cc26682108e1804ab9 Mon Sep 17 00:00:00 2001 From: Mark Mandel Date: Tue, 25 May 2021 18:07:18 -0700 Subject: [PATCH] Respectful code cleanup No.2 (#2109) Switching out some more verbiage to be more inclusive. --- .github/pull_request_template.md | 2 +- build/README.md | 2 +- cmd/sdk-server/main.go | 2 +- examples/unity-simple/README.md | 8 ++++---- site/content/en/_index.html | 2 +- site/content/en/docs/Guides/Client SDKs/local.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8ae3ad1ace..703c272b67 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,7 +6,7 @@ --> **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: +> Uncomment only one ` /kind <>` line, press enter to put that in a new line, and remove leading whitespace from that line: > > /kind breaking > /kind bug diff --git a/build/README.md b/build/README.md index fc6663a24b..c948e0c412 100644 --- a/build/README.md +++ b/build/README.md @@ -178,7 +178,7 @@ You may note that docker images, and tar archives are tagged with a concatenatio upcoming release number and short git hash for the current commit. This has also been set in the code itself, so that it can be seen in via log statements. -If you don't have a long time to kill, you can run `make build-images` to only build the images for running Agones +If you don't have a long time to wait, you can run `make build-images` to only build the images for running Agones , which is often all you need for development. Congratulations! You have now successfully tested and built Agones! diff --git a/cmd/sdk-server/main.go b/cmd/sdk-server/main.go index 7c6f8d7079..eaeff8dd0d 100644 --- a/cmd/sdk-server/main.go +++ b/cmd/sdk-server/main.go @@ -79,7 +79,7 @@ func main() { ctx := signals.NewSigKillContext() grpcServer := grpc.NewServer() - // don't graceful stop, because if we get a kill signal + // don't graceful stop, because if we get a SIGKILL signal // then the gameserver is being shut down, and we no longer // care about running RPC calls. defer grpcServer.Stop() diff --git a/examples/unity-simple/README.md b/examples/unity-simple/README.md index 081a33bef1..ee02702e25 100644 --- a/examples/unity-simple/README.md +++ b/examples/unity-simple/README.md @@ -17,7 +17,7 @@ Check out [these instructions](https://agones.dev/site/docs/installation/). ### Building a Server * Open this folder with UnityEditor. -* Hit a `Build Tool/Build Server` menu item in the menu bar. +* Click on the `Build Tool/Build Server` menu item in the menu bar. * The Builds are created in a `Builds/Server` Folder. ### Building a Docker Image and Running it @@ -30,7 +30,7 @@ $ kubectl create -f gameserver.yaml ### Building a Client * Open this folder with UnityEditor. -* Hit a `Build Tool/Build Client` menu item in the menu bar. +* Click on the `Build Tool/Build Client` menu item in the menu bar. ### How to use a Client * Run `Builds/Client/UnitySimpleClient.exe`. @@ -40,8 +40,8 @@ $ kubectl create -f gameserver.yaml NAME STATE ADDRESS PORT NODE AGE unity-simple-server-z7nln Ready 192.168.*.* 7854 node-name 1m ``` -* Hit a `Change Server` Button. -* Set any text to a center text filed and hit a `Send` button. +* Click on the `Change Server` Button. +* Set any text to a center text filed and click the `Send` button. * The Client will send the text to the Server. When a Server receives a text, it will send back "Echo : $text" as an echo. diff --git a/site/content/en/_index.html b/site/content/en/_index.html index 56f6eb6e09..826220e10c 100644 --- a/site/content/en/_index.html +++ b/site/content/en/_index.html @@ -40,7 +40,7 @@ {{% blocks/feature icon="fas fa-chart-area" title="Metrics and Monitoring" url="./docs/guides/metrics/" %}} Integration with [OpenCensus](https://opencensus.io/) -for backend agnostic game server metrics and monitoring dashboards +for platform-independent game server metrics and monitoring dashboards {{% /blocks/feature %}} diff --git a/site/content/en/docs/Guides/Client SDKs/local.md b/site/content/en/docs/Guides/Client SDKs/local.md index 96eaf4e11f..ca70ac837f 100644 --- a/site/content/en/docs/Guides/Client SDKs/local.md +++ b/site/content/en/docs/Guides/Client SDKs/local.md @@ -45,7 +45,7 @@ $ ./sdk-server.linux.amd64 --local ### Providing your own `GameServer` configuration for local development -By default, the local sdk-server will create a dummy `GameServer` configuration that is used for `GameServer()` +By default, the local sdk-server will create a default `GameServer` configuration that is used for `GameServer()` and `WatchGameServer()` SDK calls. If you wish to provide your own configuration, as either yaml or json, this can be passed through as either `--file` or `-f` along with the `--local` flag.