Skip to content

Commit 9da32a8

Browse files
authored
Merge pull request #1 from googleforgames/master
Merge to update to current
2 parents 39d9f65 + 3db0f01 commit 9da32a8

File tree

23 files changed

+94
-79
lines changed

23 files changed

+94
-79
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
# If you want information on how to edit this file checkout,
2525
# http://makefiletutorial.com/
2626

27-
BASE_VERSION = 0.0.0-dev
27+
BASE_VERSION = 1.0.0
2828
SHORT_SHA = $(shell git rev-parse --short=7 HEAD | tr -d [:punct:])
2929
VERSION_SUFFIX = $(SHORT_SHA)
3030
BRANCH_NAME = $(shell git rev-parse --abbrev-ref HEAD | tr -d [:punct:])

cloudbuild.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ steps:
113113
path: '/go'
114114

115115
substitutions:
116-
_OM_VERSION: "0.0.0-dev"
116+
_OM_VERSION: "1.0.0"
117117
_GCB_POST_SUBMIT: "0"
118118
_GCB_LATEST_VERSION: "undefined"
119119
logsBucket: 'gs://open-match-site-build-logs/'

site/config.toml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ enableRobotsTXT = true
77
theme = ["docsy"]
88

99
# Will give values to .Lastmod etc.
10-
#enableGitInfo = true
10+
# enableGitInfo = true
1111

1212
# Language settings
1313
contentDir = "content/en"
@@ -74,7 +74,7 @@ github_docs_repo = "https://github.com/googleforgames/open-match-docs"
7474
gcs_engine_id = "008748710159674449076:sqoelpnrdoe"
7575

7676
release_branch = "master"
77-
release_version = "0.0.0-dev"
77+
release_version = "1.0.0"
7878
slack_link = "https://join.slack.com/t/open-match/shared_invite/enQtNDM1NjcxNTY4MTgzLTM5ZWQxNjc1YWI3MzJmN2RiMWJmYWI0ZjFiNzNkZmNkMWQ3YWU5OGVkNzA5Yzc4OGVkOGU5MTc0OTA5ZTA5NDU"
7979

8080
# User interface configuration
@@ -112,3 +112,9 @@ no = 'Sorry to hear that. Please <a href="https://github.com/googleforgames/open
112112
url = "https://github.com/googleforgames/open-match"
113113
icon = "fab fa-github"
114114
desc = "Source Code"
115+
116+
[frontmatter]
117+
date = ["date", "publishDate", "lastmod"]
118+
lastmod = [":fileModTime"]
119+
publishDate = ["publishDate", "date"]
120+
expiryDate = ["expiryDate"]

site/content/en/_index.html

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,17 @@
4444
{{< /blocks/section >}}
4545

4646

47-
{{< blocks/section color="primary" >}}
47+
{{< blocks/section color="primary" >}}
48+
<div class="col">
49+
<h2 class="text-center pb-3">Companies using Open Match</h2>
50+
<p class="text-center showcase">
51+
<a href="http://unity.com/"><img alt="unity" width="150" src="images/unity.png" /></a>
52+
</p>
53+
</div>
54+
{{< /blocks/section >}}
55+
56+
57+
{{< blocks/section color="secondary" >}}
4858

4959
{{% blocks/feature icon="fab fa-slack" title="Join us on Slack" url="https://join.slack.com/t/open-match/shared_invite/enQtNDM1NjcxNTY4MTgzLTM5ZWQxNjc1YWI3MzJmN2RiMWJmYWI0ZjFiNzNkZmNkMWQ3YWU5OGVkNzA5Yzc4OGVkOGU5MTc0OTA5ZTA5NDU" url_text="Join us" %}}
5060
Join the community on Slack

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If there's something you see that can be [improved](https://github.com/googlefor
1313

1414
There are many ways to get in touch with the Open Match community.
1515

16-
* [Slack](https://open-match.slack.com/) ([Join](https://join.slack.com/t/open-match/shared_invite/enQtNDM1NjcxNTY4MTgzLWQzMzE1MGY5YmYyYWY3ZjE2MjNjZTdmYmQ1ZTQzMmNiNGViYmQyN2M4ZmVkMDY2YzZlOTUwMTYwMzI1Y2I2MjU)) - Talk to the Open Match engineers and users on Slack.
16+
* [Slack](https://open-match.slack.com/) ([Join](https://open-match.slack.com/join/shared_invite/zt-5k57lph3-Oe0WdatzL32xv6tPG3PfzQ#/)) - Talk to the Open Match engineers and users on Slack.
1717
* [open-match-discuss@ mailing list](https://groups.google.com/forum/#!forum/open-match-discuss) - Get the latest information on changes happening to Open Match.
1818

1919
## Code of Conduct

site/content/en/docs/Guides/custom.md renamed to site/content/en/docs/Guides/Custom/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Customize core Open Match"
3-
linkTitle: "Customize core Open Match"
2+
title: "Customize Core Open Match"
3+
linkTitle: "Customize Core Open Match"
44
weight: 5
55
description: >
66
This guide covers how to customize your Open Match deployment.
@@ -38,7 +38,7 @@ To configure Open Match with your custom config, create a new YAML file with thi
3838
kubectl apply -f <filename_here>
3939
```
4040

41-
The [Evaluator Guide]({{< relref "../Guides/evaluator.md" >}}) gives an overview of Synchronization, Evaluation and all the related configuration.
41+
The [Evaluator Guide]({{< relref "../Evaluator/_index.md" >}}) gives an overview of Synchronization, Evaluation and all the related configuration.
4242

4343
## Configurations
4444
The following tables lists the configurable parameters of the Open Match override configmap and their default values.

site/content/en/docs/Guides/evaluator.md renamed to site/content/en/docs/Guides/Evaluator/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ To allow generation of proposals using overlapping Tickets but still provide uni
5151
Open Match provides a default score based Evaluator that can be used in most common scenarios but it also provides the user the ability to build your own Evaluator and to customize Open Match to use the user's Evaluator. At a high level, there are three evaluation scenarios for you to consider when using Open Match:
5252

5353
1. Your MatchProfiles completely partition the Ticket Pool and so you will never have collisions. The default Evaluator handles this scenario and you do not have to make any changes.
54-
2. Your MatchProfiles may use overlapping Ticket Pools - but each MatchFunction can simply generate a quality score for that Match based on certain game specific criteria (latency, mmr etc.). The default Evaluator can be used for this scenario. See [Default Evaluator Tutorial]({{< relref "../Tutorials/DefaultEvaluator/_index.md" >}})
55-
3. You have complex evaluation logic that cannot be simplified to a score for a Match but rather involves actually comparing some details of the overlapping Matches. Open Match provides you with the ability to plug in your custom Evaluator to handle this case. See the [Custom Evaluator Tutorial]({{< relref "../Tutorials/CustomEvaluator/_index.md" >}}) for details.
54+
2. Your MatchProfiles may use overlapping Ticket Pools - but each MatchFunction can simply generate a quality score for that Match based on certain game specific criteria (latency, mmr etc.). The default Evaluator can be used for this scenario. See [Default Evaluator Tutorial]({{< relref "../../Tutorials/DefaultEvaluator/_index.md" >}})
55+
3. You have complex evaluation logic that cannot be simplified to a score for a Match but rather involves actually comparing some details of the overlapping Matches. Open Match provides you with the ability to plug in your custom Evaluator to handle this case. See the [Custom Evaluator Tutorial]({{< relref "../../Tutorials/CustomEvaluator/_index.md" >}}) for details.
5656

5757
### How to configure an Evaluator
5858

@@ -73,7 +73,7 @@ Concurrently executing MatchFunctions fetch Tickets for their MatchProfiles from
7373
7474
### Overview of Synchronizer States
7575
76-
Synchronizer's key role is to make sure that all the proposals generated by concurrent MatchFunctions get evaluated tgether. Further, the Synchronizer needs to halt function execution while the results are evaluated. Given that the MatchFunction is authored by the user, Open Match has no control over its execution time. However, Open Match has to make sure its results are evaluated with the other concurrent Match Functions - or are discarded if they missed the Evaluation time. To achieve this, the singleton Synchronizer component in Open Match has the following states:
76+
Synchronizer's key role is to make sure that all the proposals generated by concurrent MatchFunctions get evaluated together. Further, the Synchronizer needs to halt function execution while the results are evaluated. Given that the MatchFunction is authored by the user, Open Match has no control over its execution time. However, Open Match has to make sure its results are evaluated with the other concurrent Match Functions - or are discarded if they missed the Evaluation time. To achieve this, the singleton Synchronizer component in Open Match has the following states:
7777
7878
#### Idle State
7979

site/content/en/docs/Guides/Matchmaker/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ To build a custom Matchmaker using Open Match, the user needs to provide the fol
3939

4040
#### Match Function
4141

42-
The core matchmaking logic is implemented as a Match Function service. Open Match Backend triggers the Match Function service when it receives a request to generate matches. The Match Function execution receives MatchProfiles, fetches Tickets that match the profile from QueryService and returns matches.
42+
The core matchmaking logic is implemented as a Match Function service. Open Match Backend triggers the Match Function service when it receives a request to generate Matches. The Match Function execution receives MatchProfiles, fetches Tickets that match the profile from QueryService and returns Matches.
4343

4444
#### Evaluator (Optional)
4545

46-
Open Match allows for concurrent Match Functions to execute on the same player pool. The matches generated by such concurrent Match Function executions may have overlapping Tickets. Given that one Ticket should only be used by a result, Open Match allows the user to plug in an Evaluator component to deduplicate matches before returning results. Open Match provides a default Evaluator which suffices for most common use cases. See [Evaluator Guide]({{< relref "../evaluator.md" >}}) for details on proposal evaluation.
46+
Open Match allows for concurrent Match Functions to execute on the same player pool. The Matches generated by such concurrent Match Function executions may have overlapping Tickets. Given that one Ticket should only be used by one resulting Match, Open Match allows the user to plug in an Evaluator component to deduplicate Match proposals before returning results. Open Match provides a default Evaluator which suffices for most common use cases. See [Evaluator Guide]({{< relref "../Evaluator/_index.md" >}}) for details on proposal evaluation.
4747

4848
### External Components
4949

@@ -61,7 +61,7 @@ This is the component that receives the matchmaking request from the game client
6161

6262
This is the component that understands the types of matches (MatchProfiles) that can be served and fetches matches
6363
from the Open Match Backend. The Director also interfaces with the DGS allocation system to fetch Game Servers for
64-
matches and creating Game Server Assignments from these details in Open Match, via communicating with the Open Match
64+
Matches and creating Game Server Assignments from these details in Open Match, via communicating with the Open Match
6565
Backend.
6666

6767
### Matchmaking Flow

site/content/en/docs/Guides/telemetry/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The configurations to enable/disable the telemetry exporters are not read at run
4949
{{% /alert %}}
5050

5151
You can configure where and what telemetry you want to emit from your Open Match
52-
deployment. To instrument Open Match with telemetry supports, modify your `06-open-match-override-configmap.yaml` to override the related settings. Please refer to [how to customize your Open Match deployment]({{< relref "../custom.md/#telemetry" >}}) for more details.
52+
deployment. To instrument Open Match with telemetry supports, modify your `06-open-match-override-configmap.yaml` to override the related settings. Please refer to [how to customize your Open Match deployment]({{< relref "../Custom/_index.md/#telemetry" >}}) for more details.
5353

5454
Below is an example of the data section in `om-configmap-override` configmap to enable all of the supported telemetry exporters:
5555
```yaml

site/content/en/docs/Installation/helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: >
99
## Prerequisites
1010

1111
- [Helm](https://docs.helm.sh/helm/) package manager 3.0.0+
12-
- [Kuberentes](https://kubernetes.io) cluster, tested on Kubernetes version 1.13+
12+
- [Kubernetes](https://kubernetes.io) cluster, tested on Kubernetes version 1.13+
1313

1414
## Install the Open Match helm chart
1515

site/content/en/docs/Installation/yaml.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ Thus, starting the core service pods will remain in <code>ContainerCreating</cod
5757

5858
- If you are proceeding with the [Getting Started]({{< relref "../Getting Started/_index.md" >}}), or following the [Tutorials]({{< relref "../Tutorials/_index.md" >}}), proceed with this guide to [install the default Evaluator]({{< ref "#install-the-default-evaluator" >}}) and configure Open Match to use it.
5959

60-
- If you finished reading the tutorials and are building your own custom matchmaker and need to deploy a custom evaluator, then skip the next step and instead use the [Customization Guide]({{< relref "../Guides/custom.md" >}}) for steps to customize your Open Match installation.
60+
- If you finished reading the tutorials and are building your own custom matchmaker and need to deploy a custom evaluator, then skip the next step and instead use the [Customization Guide]({{< relref "../Guides/Custom/_index.md" >}}) for steps to customize your Open Match installation.
6161

62-
## Install the default Evaluator
62+
## Install the Default Evaluator
6363

6464
Run the below command to install the default Evaluator in the open-match namespace and to configure Open Match to use it.
6565

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@ description: >
66
Open Match is an open-source matchmaking framework that simplifies building your game matchmaker.
77
---
88

9-
## Disclaimer
10-
11-
This software is currently [alpha](https://github.com/googleforgames/open-match/releases), and
12-
subject to change. Not to be used in production systems.
13-
149
## What is Open Match
1510

1611
Open Match is an open-source game matchmaking framework that simplifies building a scalable and extensible Matchmaker.

0 commit comments

Comments
 (0)