Skip to content

Commit 07aa803

Browse files
committed
Move the README.md into /agones/ so it's in the Helm Chart
This will mean Helm hub will get a nice readme on the landing page.
1 parent 9bb39a7 commit 07aa803

5 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/limiting_resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ If you do not set a limit or request, the default is set my Kubernetes at a 100m
4848
You may also want to tweak the CPU request or limits on the SDK `GameServer` sidecar process that spins up alongside
4949
each game server container.
5050

51-
You can do this through the [Helm configuration](../install/helm/README.md#configuration) when installing Agones.
51+
You can do this through the [Helm configuration](../install/helm/agones/README.md#configuration) when installing Agones.
5252

5353
By default, this is set to having a CPU request value of 30m, with no hard CPU limit. This ensures that the sidecar always has enough CPU
5454
to function, but it is configurable in case a lower, or higher value is required on your clusters, or if you desire

docs/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Finally include that `ServiceMonitor` in your [Prometheus instance CRD](https://
3737
### Stackdriver
3838

3939
We don't yet support the [OpenCensus Stackdriver exporter](https://opencensus.io/exporters/supported-exporters/go/stackdriver/) but you can still use the Prometheus Stackdriver integration by following these [instructions](https://cloud.google.com/monitoring/kubernetes-engine/prometheus).
40-
Annotations required by this integration can be activated by setting the `agones.metrics.prometheusServiceDiscovery` to true (default) via the [helm chart value](../install/helm/README.md#configuration).
40+
Annotations required by this integration can be activated by setting the `agones.metrics.prometheusServiceDiscovery` to true (default) via the [helm chart value](../install/helm/agones/README.md#configuration).
4141

4242
## Metrics available
4343

docs/ping_service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ for the purpose of timing how long the rountrip takes for information to be retu
1212

1313
By default, Agones installs [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service/) for
1414
both HTTP and the UDP ping endpoints. These can be disabled entirely,
15-
or disabled individually. See the [Helm install guide](../install/helm/README.md) for the parameters to pass through,
15+
or disabled individually. See the [Helm install guide](../install/helm/agones/README.md) for the parameters to pass through,
1616
as well as configuration options.
1717

1818
The ping services as all installed under the `agones-system` namespace.

install/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ Also, we can install Agones using [Helm][helm] package manager. If you want more
305305
options see the [Helm installation guide for Agones][agones-install-guide]
306306

307307
[helm]: https://docs.helm.sh
308-
[agones-install-guide]: helm/README.md
308+
[agones-install-guide]: helm/agones/README.md
309309

310310
## Confirming Agones started successfully
311311

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ The following tables lists the configurable parameters of the Agones chart and t
127127
| `gameservers.maxPort` | Maximum port to use for dynamic port allocation | `8000` |
128128

129129
[constraints]: https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/cpu-constraint-namespace/
130-
[ping]: ../../docs/ping_service.md
130+
[ping]: ../../../docs/ping_service.md
131131
[service]: https://kubernetes.io/docs/concepts/services-networking/service/
132132

133133
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
@@ -145,7 +145,7 @@ Alternatively, a YAML file that specifies the values for the parameters can be p
145145
$ helm install --name my-release --namespace agones-system -f values.yaml agones/agones
146146
```
147147

148-
> **Tip**: You can use the default [values.yaml](agones/values.yaml)
148+
> **Tip**: You can use the default [values.yaml](values.yaml)
149149
150150
## TLS Certificates
151151

@@ -156,4 +156,4 @@ For most used cases the controller would have required a restart anyway (eg: con
156156
157157
## Confirm Agones is running
158158

159-
To confirm Agones is up and running, [go to the next section](../README.md#confirming-agones-started-successfully)
159+
To confirm Agones is up and running, [go to the next section](../../README.md#confirming-agones-started-successfully)

0 commit comments

Comments
 (0)