From abfbff0018d7572e7b1ac158223cf0b1fd7ada76 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 13 May 2024 19:07:20 -0600 Subject: [PATCH 1/6] 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 From dfa7cef33aa303644dd13408425f76a00bf9c847 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 14 May 2024 16:09:01 -0600 Subject: [PATCH 2/6] docs: Restore warning to original location Signed-off-by: Matt Fisher --- docs/quick-start.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index b98dbfaf6595..606e3e194c30 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -14,7 +14,6 @@ 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. @@ -23,6 +22,8 @@ To install Argo Workflows for development or evaluation, use the 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: From f019a3bdbaee27bbea53c479114bfb98cebf74b2 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 14 May 2024 16:10:02 -0600 Subject: [PATCH 3/6] docs: Clarify instructional language Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Signed-off-by: Matt Fisher --- docs/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index 606e3e194c30..6812484f60b7 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -31,7 +31,7 @@ command below: ARGO_WORKFLOWS_VERSION="vX.Y.Z" ``` -Next, copy the command below to apply the quick-start manifest: +Then, copy the commands below to apply the quick-start manifest: ```bash kubectl create namespace argo From 5988696517dd7e52c33dc31d0173cc9478047444 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 14 May 2024 16:10:23 -0600 Subject: [PATCH 4/6] docs: Remove superfluous prose Signed-off-by: Matt Fisher --- docs/quick-start.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index 6812484f60b7..ccc7189fe526 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -14,10 +14,6 @@ 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/) - -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). From 62fd51e3f8d51071623f3dc4dac97787260776db Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 14 May 2024 16:11:34 -0600 Subject: [PATCH 5/6] docs: One sentence per line Signed-off-by: Matt Fisher --- docs/quick-start.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index ccc7189fe526..952fe0ce76ac 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -20,8 +20,8 @@ For quick testing, you can use a local cluster with: ## Install Argo Workflows -First, specify the version you'd like to install in an environment variable. Modify the -command below: +First, specify the version you'd like to install in an environment variable. +Modify the command below: ```bash ARGO_WORKFLOWS_VERSION="vX.Y.Z" From 5aca59538a7dffd2341e2f5e3b58ca543a937514 Mon Sep 17 00:00:00 2001 From: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Date: Wed, 15 May 2024 20:41:32 -0400 Subject: [PATCH 6/6] simplify contraction Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> --- docs/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index 952fe0ce76ac..858ad3b3bd7c 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -20,7 +20,7 @@ For quick testing, you can use a local cluster with: ## Install Argo Workflows -First, specify the version you'd like to install in an environment variable. +First, specify the version you want to install in an environment variable. Modify the command below: ```bash