From 3371b21e957dfb5c258fe41162df93e2e18c4f2c Mon Sep 17 00:00:00 2001 From: Mark Mandel Date: Fri, 25 May 2018 12:39:03 -0700 Subject: [PATCH] Release steps of archiving installation resources and documentation Moved the installation documentation into the `install` directory and on release, zip up the install instructions and yaml files such that users can download and use them. --- README.md | 2 +- build/Makefile | 2 +- docs/create_fleet.md | 2 +- docs/create_gameserver.md | 2 +- docs/installing_agones.md => install/README.md | 2 +- install/helm/README.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) rename docs/installing_agones.md => install/README.md (99%) diff --git a/README.md b/README.md index 40d6cc8855..9d6f918941 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ For more details on why this project was written, read the ## Installation -Follow [these instructions](./docs/installing_agones.md) to create a cluster on Google Kubernetes Engine (GKE) or Minikube, and install Agones. +Follow [these instructions](install/README.md) to create a cluster on Google Kubernetes Engine (GKE) or Minikube, and install Agones. ## Usage diff --git a/build/Makefile b/build/Makefile index 4babf46703..bfb148944c 100644 --- a/build/Makefile +++ b/build/Makefile @@ -259,7 +259,7 @@ do-release: cp $(agones_path)/cmd/sdk-server/bin/agonessdk-server-$(RELEASE_VERSION).zip $(agones_path)/release cp $(agones_path)/sdks/cpp/bin/agonessdk-$(RELEASE_VERSION)-runtime-linux-arch_64.tar.gz $(agones_path)/release cp $(agones_path)/sdks/cpp/bin/agonessdk-$(RELEASE_VERSION)-dev-linux-arch_64.tar.gz $(agones_path)/release - zip --junk-paths $(agones_path)/release/agones-$(RELEASE_VERSION).zip $(agones_path)/README.md $(agones_path)/install.yaml $(agones_path)/LICENSE + cd $(agones_path) && zip -r ./release/agones-install-$(RELEASE_VERSION).zip ./README.md ./install ./LICENSE $(MAKE) gcloud-auth-docker push VERSION=$(RELEASE_VERSION) git push -u origin release-$(RELEASE_VERSION) @echo "Now go make the $(RELEASE_VERSION) release on Github!" diff --git a/docs/create_fleet.md b/docs/create_fleet.md index c62bf61775..bfbc1f5ba3 100644 --- a/docs/create_fleet.md +++ b/docs/create_fleet.md @@ -16,7 +16,7 @@ The following prerequisites are required to create a GameServer: >NOTE: Agones required Kubernetes versions 1.9+ to run. See the [cluster requirements](../README.md#requirements) for more details. -If you don't have a Kubernetes cluster you can follow [these instructions](installing_agones.md) to create a cluster on Google Kubernetes Engine (GKE) or Minikube, and install Agones. +If you don't have a Kubernetes cluster you can follow [these instructions](../install/README.md) to create a cluster on Google Kubernetes Engine (GKE) or Minikube, and install Agones. For the purpose of this guide we're going to use the [simple-udp](../examples/simple-udp/) example as the GameServer container. This example is very simple UDP server written in Go. Don't hesitate to look at the code of this example for more information. diff --git a/docs/create_gameserver.md b/docs/create_gameserver.md index 1b1ca9ce6b..1173fc0260 100644 --- a/docs/create_gameserver.md +++ b/docs/create_gameserver.md @@ -19,7 +19,7 @@ The following prerequisites are required to create a GameServer : >NOTE: Agones required Kubernetes versions 1.9 with role-based access controls (RBAC) and MutatingAdmissionWebhook features activated. To check your version, enter `kubectl version`. -If you don't have a Kubernetes cluster you can follow [these instructions](installing_agones.md) to create a cluster on Google Kubernetes Engine (GKE) or Minikube, and install Agones. +If you don't have a Kubernetes cluster you can follow [these instructions](../install/README.md) to create a cluster on Google Kubernetes Engine (GKE) or Minikube, and install Agones. For the purpose of this guide we're going to use the [simple-udp](../examples/simple-udp/) example as the GameServer container. This example is very simple UDP server written in Go. Don't hesitate to look at the code of this example for more information. diff --git a/docs/installing_agones.md b/install/README.md similarity index 99% rename from docs/installing_agones.md rename to install/README.md index 5076204183..71e05be320 100644 --- a/docs/installing_agones.md +++ b/install/README.md @@ -203,7 +203,7 @@ Also, we can install Agones using [Helm][helm] package manager. If you want more options see the [Helm installation guide for Agones][agones-install-guide] [helm]: https://docs.helm.sh -[agones-install-guide]: ../install/helm/README.md +[agones-install-guide]: helm/README.md ## Confirming Agones started successfully diff --git a/install/helm/README.md b/install/helm/README.md index 5b18fcaa02..4ef8197d76 100644 --- a/install/helm/README.md +++ b/install/helm/README.md @@ -102,4 +102,4 @@ $ helm install --name my-release -f values.yaml agones ## Confirm Agones is running -To confirm Agones is up and running, [go to the next section](../../docs/installing_agones.md#confirming-agones-started-successfully) \ No newline at end of file +To confirm Agones is up and running, [go to the next section](../README.md#confirming-agones-started-successfully) \ No newline at end of file