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.

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

update installation docs #300

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/content/en/docs/Guides/Evaluator/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. 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.

The ability to provide this model of executing concurrent MatchFunctions on overlapping Ticket Pool is a core value proposition of Open Match.

Expand Down
2 changes: 1 addition & 1 deletion site/content/en/docs/Installation/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ helm install open-match --create-namespace --namespace open-match open-match/ope
{{% alert title="Note" color="info" %}}
Open Match needs to be customized to run as a Matchmaker.
This custom configuration is provided to the Open Match components via a ConfigMap
(<code>om-configmap-override</code>).
(<code>open-match-configmap-override</code>).

Thus, starting the core service pods will remain in <code>ContainerCreating</code> until this config map is available.
{{% /alert %}}
Expand Down
14 changes: 7 additions & 7 deletions site/content/en/docs/Installation/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,18 @@ kubectl get -n open-match pod
```
Output:

NAME READY STATUS RESTARTS AGE
om-backend-76d8d76c96-fmhmn 0/1 ContainerCreating 0 3m53s
om-frontend-57fc9f6b66-86hxj 0/1 ContainerCreating 0 3m53s
om-query-799d8549d4-5qpgx 0/1 ContainerCreating 0 3m53s
om-swaggerui-867d79b885-m9q6x 0/1 ContainerCreating 0 3m54s
om-synchronizer-7f48f84dfd-j8swx 0/1 ContainerCreating 0 3m54s
NAME READY STATUS RESTARTS AGE
open-match-backend-76d8d76c96-fmhmn 0/1 ContainerCreating 0 3m53s
open-match-frontend-57fc9f6b66-86hxj 0/1 ContainerCreating 0 3m53s
open-match-query-799d8549d4-5qpgx 0/1 ContainerCreating 0 3m53s
open-match-swaggerui-867d79b885-m9q6x 0/1 ContainerCreating 0 3m54s
open-match-synchronizer-7f48f84dfd-j8swx 0/1 ContainerCreating 0 3m54s
```

{{% alert title="Note" color="info" %}}
Open Match needs to be customized to run as a Matchmaker.
This custom configuration is provided to the Open Match components via a ConfigMap
(<code>om-configmap-override</code>).
(<code>open-match-configmap-override</code>).

Thus, starting the core service pods will remain in <code>ContainerCreating</code> until this config map is available.
{{% /alert %}}
Expand Down