From 94f1316209ebdb41356fab8c59f049cb6b1335e3 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 13 May 2024 19:07:20 -0600 Subject: [PATCH] fix(docs): Clarify the quick start instructions I got hung up on these because I copied the commands from the releases page instead of from the quick start page, so I accidentally applied `install.yaml` instead of `quick-start-minimal.yaml`. I hope this change will help others not get confused like me :) Signed-off-by: Matt Fisher --- docs/quick-start.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index 79ff12b8bd7d..b98dbfaf6595 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -14,20 +14,27 @@ For quick testing, you can use a local cluster with: * [k3s](https://k3s.io/) or [k3d](https://k3d.io/) * [Docker Desktop](https://www.docker.com/products/docker-desktop/) +## Install Argo Workflows + +To install Argo Workflows for development or evaluation, use the +`quick-start-minimal.yaml` manifest provided with each release. + !!! Warning "Development vs. Production" These instructions are intended to help you get started quickly. They are not suitable for production. For production installs, please refer to [the installation documentation](installation.md). -## Install Argo Workflows +First, specify the version you'd like to install in an environment variable. Modify the +command below: -To install Argo Workflows, go to the [releases page](https://github.com/argoproj/argo-workflows/releases/latest). -Scroll down to the `Controller and Server` section and execute the `kubectl` commands. +```bash +ARGO_WORKFLOWS_VERSION="vX.Y.Z" +``` -Below is an example of the install commands (substitute `<>` with the version number): +Next, copy the command below to apply the quick-start manifest: ```bash kubectl create namespace argo -kubectl apply -n argo -f https://github.com/argoproj/argo-workflows/releases/download/v<>/quick-start-minimal.yaml +kubectl apply -n argo -f "https://github.com/argoproj/argo-workflows/releases/download/${ARGO_WORKFLOWS_VERSION}/quick-start-minimal.yaml" ``` ## Install the Argo Workflows CLI