From c49fe7bd15ff635fcd3aa7363998d329b7fe2b6c Mon Sep 17 00:00:00 2001 From: Mark Mandel Date: Wed, 27 Mar 2019 21:41:37 -0700 Subject: [PATCH] Minor tweaks to documentation - Update old 0.4.0 references to be dynamic - Point the API guide to the new reference. --- site/content/en/docs/Guides/access-api.md | 10 ++++------ site/content/en/docs/Installation/helm.md | 6 +++--- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/site/content/en/docs/Guides/access-api.md b/site/content/en/docs/Guides/access-api.md index 56859f1fde..8bbb7f6992 100644 --- a/site/content/en/docs/Guides/access-api.md +++ b/site/content/en/docs/Guides/access-api.md @@ -237,7 +237,6 @@ $ curl http://localhost:8001/apis/stable.agones.dev/v1alpha1/namespaces/default/ } # allocate a gameserver from a fleet named 'simple-udp' -# (in 0.4.0 you won't need to specify the namespace in the FleetAllocation metadata config) $ curl -d '{"apiVersion":"stable.agones.dev/v1alpha1","kind":"FleetAllocation","metadata":{"generateName":"simple-udp-", "namespace": "default"},"spec":{"fleetName":"simple-udp"}}' -H "Content-Type: application/json" -X POST http://localhost:8001/apis/stable.agones.dev/v1alpha1/namespaces/default/fleetallocations @@ -344,12 +343,11 @@ $ curl -d '{"apiVersion":"stable.agones.dev/v1alpha1","kind":"FleetAllocation"," } ``` -The [Verb Resources](https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#verbs-on-resources) -section provide the more details on the API conventions that are used in the Kubernetes API. - -It may also be useful to look at the [API patterns for standard Kubernetes resources](https://v1-10.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#-strong-write-operations-strong--54). +You may wish to review the [Agones Kubernetes API]({{< ref "/docs/Reference/agones_crd_api_reference.html" >}}) for the full data structure reference. +The [Verb Resources](https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#verbs-on-resources) +section may also provide the more details on the API conventions that are used in the Kubernetes API. ## Next Steps -Learn how to interact with Agones programmatically through the API while creating an [Allocator Service]({{< relref "../Tutorials/allocator-service-go.md" >}}). +- Learn how to interact with Agones programmatically through the API while creating an [Allocator Service]({{< relref "../Tutorials/allocator-service-go.md" >}}). diff --git a/site/content/en/docs/Installation/helm.md b/site/content/en/docs/Installation/helm.md index c75579375f..7b55b25102 100644 --- a/site/content/en/docs/Installation/helm.md +++ b/site/content/en/docs/Installation/helm.md @@ -45,11 +45,11 @@ The command deploys Agones on the Kubernetes cluster with the default configurat > **Tip**: List all releases using `helm list` -> If you are installing a development build of Agones (i.e. not the 0.4.0 release), you will need to install Agones the following way: +> If you are installing a development build of Agones (i.e. not the {{< release-version >}} release), you will need to install Agones the following way: ```bash $ cd install/helm/ -$ helm install --name my-release --namespace agones-system agones --set agones.image.tag=0.4.0-481970d +$ helm install --name my-release --namespace agones-system agones --set agones.image.tag={{< release-version >}}-481970d ``` The full list of available tags is [here](https://console.cloud.google.com/gcr/images/agones-images/) @@ -114,7 +114,7 @@ The following tables lists the configurable parameters of the Agones chart and t | `agones.serviceaccount.controller` | Service account name for the controller | `agones-controller` | | `agones.serviceaccount.sdk` | Service account name for the sdk | `agones-sdk` | | `agones.image.registry` | Global image registry for all images | `gcr.io/agones-images` | -| `agones.image.tag` | Global image tag for all images | `0.4.0` | +| `agones.image.tag` | Global image tag for all images | `{{< release-version >}}` | | `agones.image.controller.name` | Image name for the controller | `agones-controller` | | `agones.image.controller.pullPolicy` | Image pull policy for the controller | `IfNotPresent` | | `agones.image.controller.pullSecret` | Image pull secret for the controller | `` |