googleforgames / googleforgames/open-match-docs

Install with Helm is confusing

Open
#212 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
16
Forks
42
PR merge metrics
No merged PRs in 30d

Description

The issues I found trying to run

1. No mention that you need to manually create namespaces. I suggest adding the add namespace command before it.
2. After install, the note that it will be broken is below the command itself. I was debugging for a while why was not working until giving up to read the next step and found it was expected. I suggest but the note before or just remove it completely from gettings started (see 3)
3. The install of the default evaluator can not be executed because you already have a released installed. "Default Evaluator" looks like just an extra component, not that you are reinstalling the full stack but now working with some defaults. I suggest just replace this command with a previously broken install and comment that you are installing with default values. Or replace the evaluator install by "helm upgrade" and describe that you are now upgrading it with default configurations.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.