From b8d6a354d2452d8704bf59502b5663b83ce126b9 Mon Sep 17 00:00:00 2001 From: Alexander Apalikov Date: Tue, 8 Sep 2020 15:57:46 +0300 Subject: [PATCH] Fixed various spelling mistakes Note that there is a need to update comments in proto files. --- site/content/en/docs/Guides/Api/_index.md | 2 +- site/content/en/docs/Guides/Evaluator/_index.md | 4 ++-- site/content/en/docs/Guides/Matchmaker/frontend.md | 2 +- site/content/en/docs/Guides/Matchmaker/matchfunction.md | 2 +- site/content/en/docs/Guides/Production/_index.md | 2 +- site/content/en/docs/Installation/helm.md | 2 +- site/content/en/docs/Installation/yaml.md | 2 +- site/content/en/docs/Reference/api.md | 6 +++--- site/content/en/docs/Tutorials/Matchmaker101/_index.md | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/site/content/en/docs/Guides/Api/_index.md b/site/content/en/docs/Guides/Api/_index.md index bb6d4450..3f74e485 100644 --- a/site/content/en/docs/Guides/Api/_index.md +++ b/site/content/en/docs/Guides/Api/_index.md @@ -7,7 +7,7 @@ description: > --- Open Match has a resource-based REST API that is served from HTTP and gRPC. It also -complies with the OpenAPI (fka Swagger) API specification which means it's easy to +complies with the OpenAPI (aka Swagger) API specification which means it's easy to download the schema and [generate clients](https://swagger.io/tools/swagger-codegen/) in many different languages. diff --git a/site/content/en/docs/Guides/Evaluator/_index.md b/site/content/en/docs/Guides/Evaluator/_index.md index e0dfe9df..0b79f863 100644 --- a/site/content/en/docs/Guides/Evaluator/_index.md +++ b/site/content/en/docs/Guides/Evaluator/_index.md @@ -36,7 +36,7 @@ The Director could request for the following Profiles: In this case, the MatchFunction executing Profile1 and Profile2 will have some common players they consider for generating Matches (Similarly with Profile2 and Profile3). Thus, the generated Matches may have overlapping Tickets. -This overlap is desired in some real matchmaking scenarios, . Inorder to generate high quality Matches, you may want your Ticket to be considered concurrently for multiple possible MatchProfiles and then be able to compare the quality of these overlapping Matches, picking the highest quality Match and discarding the rest. For instance in the above example, a Ticket with mmr 3 could be a part of a Matches generated by Profile1 and Profile2. Based on the game design and the mmr of other Tickets in these overlapping Matches, one of these two Matches may actually be a better fit for this Ticket - and thus, searching for Matches with overlapping mmr ranges resulted in considering 2 options for this Ticket and picking the better fit. +This overlap is desired in some real matchmaking scenarios. In order to generate high quality Matches, you may want your Ticket to be considered concurrently for multiple possible MatchProfiles and then be able to compare the quality of these overlapping Matches, picking the highest quality Match and discarding the rest. For instance, in the above example, a Ticket with mmr 3 could be a part of a Matches generated by Profile1 and Profile2. Based on the game design and the mmr of other Tickets in these overlapping Matches, one of these two Matches may actually be a better fit for this Ticket - and thus, searching for Matches with overlapping mmr ranges resulted in considering 2 options for this Ticket and picking the better fit. The ability to provide this model of executing concurrent MatchFunctions on overlapping Ticket Pool is a core value proposition of Open Match. @@ -56,7 +56,7 @@ Open Match provides a default score based Evaluator that can be used in most com ### How to configure an Evaluator -Inorder to invoke the Evaluator at runtime, Open Match needs to know the location of the Evaluator endpoint. This is provided to Open Match as an override ConfigMap. Here are the field in that config map that specifically configure an Evaluator in Open Match: +In order to invoke the Evaluator at runtime, Open Match needs to know the location of the Evaluator endpoint. This is provided to Open Match as an override ConfigMap. Here are the field in that config map that specifically configure an Evaluator in Open Match: ```yaml api: diff --git a/site/content/en/docs/Guides/Matchmaker/frontend.md b/site/content/en/docs/Guides/Matchmaker/frontend.md index 7c73a116..ba2f0582 100644 --- a/site/content/en/docs/Guides/Matchmaker/frontend.md +++ b/site/content/en/docs/Guides/Matchmaker/frontend.md @@ -80,7 +80,7 @@ rpc GetTicket(GetTicketRequest) returns (Ticket) { ``` {{% alert title="Note" color="info" %}} -Open Match does not guarantee persistent storage and hence should not be used as the authoritative source for Game Client Assignment information. Once the Assignment for a Ticket is fetched, the Game Frontent should (if necessary) persist this information in its own persistent storage for future lookup. +Open Match does not guarantee persistent storage and hence should not be used as the authoritative source for Game Client Assignment information. Once the Assignment for a Ticket is fetched, the Game Frontend should (if necessary) persist this information in its own persistent storage for future lookup. {{% /alert %}} ### Deleting a Ticket diff --git a/site/content/en/docs/Guides/Matchmaker/matchfunction.md b/site/content/en/docs/Guides/Matchmaker/matchfunction.md index df3ad858..e81e1eec 100644 --- a/site/content/en/docs/Guides/Matchmaker/matchfunction.md +++ b/site/content/en/docs/Guides/Matchmaker/matchfunction.md @@ -48,7 +48,7 @@ rpc QueryTickets(QueryTicketsRequest) returns (stream QueryTicketsResponse) { } ``` -Given that this functionality will be most commonly required for Match Functions, Open Match provides a golang library ("open-match.dev/open-match/pkg/matchfunction") to abstract this logic: +Given that this functionality will be most commonly required for Match Functions, Open Match provides a Golang library ("open-match.dev/open-match/pkg/matchfunction") to abstract this logic: ```golang func QueryPools(ctx context.Context, mml pb.QueryServiceClient, pools []*pb.Pool) (map[string][]*pb.Ticket, error) diff --git a/site/content/en/docs/Guides/Production/_index.md b/site/content/en/docs/Guides/Production/_index.md index e828c408..86a03750 100644 --- a/site/content/en/docs/Guides/Production/_index.md +++ b/site/content/en/docs/Guides/Production/_index.md @@ -90,5 +90,5 @@ Open Match project provides a recommended helm config file for production setups helm install my-release -n open-match open-match/open-match -f values-production.yaml ``` -## Use Enovy or other load balancing solution if you plan to connect to Open Match via an out-of-cluster client +## Use Envoy or other load balancing solution if you plan to connect to Open Match via an out-of-cluster client The above load balancing solution is sufficient if you have both the client and the server deployment within the same cluster. However, some game architectures may requires connecting to Open Match services from an out-of-cluster client. We recommend [Envoy](https://www.envoyproxy.io/) as a solution. Alternatives like Kubernetes Ingress or platform specific L7 Load Balancer can also work. \ No newline at end of file diff --git a/site/content/en/docs/Installation/helm.md b/site/content/en/docs/Installation/helm.md index 77845fac..cae114d9 100644 --- a/site/content/en/docs/Installation/helm.md +++ b/site/content/en/docs/Installation/helm.md @@ -94,7 +94,7 @@ The following tables lists the configurable parameters of the Open Match chart a | `open-match-scale.enabled` | Turn on/off the installation of Open Match scale testing setups | `false` | | `global.kubernetes.serviceAccount` | Service account name for the Open Match core services | `open-match-unprivileged-service` | | `global.kubernetes.service.portType` | Overrides the ServiceTypes for all Open Match core services | `` | -| `global.gcpProjectId` | Overrides the default gcp project id for use with stackdriver | `replace_with_your_project_id` | +| `global.gcpProjectId` | Overrides the default gcp project id for use with Stackdriver | `replace_with_your_project_id` | | `global.tls.enabled` | Turn on/off TLS encryption for all Open Match traffics | `false` | | `global.tls.server.mountPath` | The VolumeMount path for TLS server | `/app/secrets/tls/server` | | `global.tls.rootca.mountPath` | The VolumeMount path for TLS CA | `/app/secrets/tls/rootca` | diff --git a/site/content/en/docs/Installation/yaml.md b/site/content/en/docs/Installation/yaml.md index f0a09a0b..5744b971 100644 --- a/site/content/en/docs/Installation/yaml.md +++ b/site/content/en/docs/Installation/yaml.md @@ -19,7 +19,7 @@ The `01-open-match-core.yaml` contains: * Core Open Match service deployments. * A Redis deployment as Open Match's state storage system. * ServiceAccounts, Roles, and RoleBindings to define Open Match deployments' IAMs. -* HorizontalAutoScalars to auto-scale Open Match based on pods' average CPU utilization. +* HorizontalPodAutoscaler to auto-scale Open Match based on pods' average CPU utilization. Here is the command to install the Open Match core in your cluster: diff --git a/site/content/en/docs/Reference/api.md b/site/content/en/docs/Reference/api.md index 7c25c1fd..95cc0321 100644 --- a/site/content/en/docs/Reference/api.md +++ b/site/content/en/docs/Reference/api.md @@ -536,7 +536,7 @@ The MatchFunction service implements APIs to run user-defined matchmaking logics | Method Name | Request Type | Response Type | Description | | ----------- | ------------ | ------------- | ------------| -| Run | [RunRequest](#openmatch.RunRequest) | [RunResponse](#openmatch.RunResponse) stream | DO NOT CALL THIS FUNCTION MANUALLY. USE backend.FetchMatches INSTEAD. Run pulls Tickets that satisify Profile constraints from QueryService, runs matchmaking logics against them, then constructs and streams back match candidates to the Backend service. | +| Run | [RunRequest](#openmatch.RunRequest) | [RunResponse](#openmatch.RunResponse) stream | DO NOT CALL THIS FUNCTION MANUALLY. USE backend.FetchMatches INSTEAD. Run pulls Tickets that satisfy Profile constraints from QueryService, runs matchmaking logics against them, then constructs and streams back match candidates to the Backend service. | @@ -933,8 +933,8 @@ The QueryService service implements helper APIs for Match Function to query Tick | Method Name | Request Type | Response Type | Description | | ----------- | ------------ | ------------- | ------------| -| QueryTickets | [QueryTicketsRequest](#openmatch.QueryTicketsRequest) | [QueryTicketsResponse](#openmatch.QueryTicketsResponse) stream | QueryTickets gets a list of Tickets that match all Filters of the input Pool. - If the Pool contains no Filters, QueryTickets will return all Tickets in the state storage. QueryTickets pages the Tickets by `queryPageSize` and stream back responses. - queryPageSize is default to 1000 if not set, and has a mininum of 10 and maximum of 10000. | -| QueryTicketIds | [QueryTicketIdsRequest](#openmatch.QueryTicketIdsRequest) | [QueryTicketIdsResponse](#openmatch.QueryTicketIdsResponse) stream | QueryTicketIds gets the list of TicketIDs that meet all the filtering criteria requested by the pool. - If the Pool contains no Filters, QueryTicketIds will return all TicketIDs in the state storage. QueryTicketIds pages the TicketIDs by `queryPageSize` and stream back responses. - queryPageSize is default to 1000 if not set, and has a mininum of 10 and maximum of 10000. | +| QueryTickets | [QueryTicketsRequest](#openmatch.QueryTicketsRequest) | [QueryTicketsResponse](#openmatch.QueryTicketsResponse) stream | QueryTickets gets a list of Tickets that match all Filters of the input Pool. - If the Pool contains no Filters, QueryTickets will return all Tickets in the state storage. QueryTickets pages the Tickets by `queryPageSize` and stream back responses. - queryPageSize is default to 1000 if not set, and has a minimum of 10 and maximum of 10000. | +| QueryTicketIds | [QueryTicketIdsRequest](#openmatch.QueryTicketIdsRequest) | [QueryTicketIdsResponse](#openmatch.QueryTicketIdsResponse) stream | QueryTicketIds gets the list of TicketIDs that meet all the filtering criteria requested by the pool. - If the Pool contains no Filters, QueryTicketIds will return all TicketIDs in the state storage. QueryTicketIds pages the TicketIDs by `queryPageSize` and stream back responses. - queryPageSize is default to 1000 if not set, and has a minimum of 10 and maximum of 10000. | diff --git a/site/content/en/docs/Tutorials/Matchmaker101/_index.md b/site/content/en/docs/Tutorials/Matchmaker101/_index.md index 446acade..a2434029 100644 --- a/site/content/en/docs/Tutorials/Matchmaker101/_index.md +++ b/site/content/en/docs/Tutorials/Matchmaker101/_index.md @@ -16,7 +16,7 @@ description: > ### Set up a Kubernetes Cluster -Some basic understanding of Kubernetes, kubectl is required to efficiently completely this tutorial. Follow the instructions to [set up a Kubernetes cluster]({{< relref "../../Installation/_index.md#setup-kubernetes-cluster" >}}), install and configure kubectl to connect to this cluster. +Some basic understanding of Kubernetes, kubectl is required to efficiently complete this tutorial. Follow the instructions to [set up a Kubernetes cluster]({{< relref "../../Installation/_index.md#setup-kubernetes-cluster" >}}), install and configure kubectl to connect to this cluster. ### Install Open Match