Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): Clarify quick start installation. Fixes #13032 #13047

Merged
merged 6 commits into from
May 16, 2024
Merged

fix(docs): Clarify quick start installation. Fixes #13032 #13047

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
abfbff0
fix(docs): Clarify the quick start instructions
mfisher87 May 14, 2024
dfa7cef
docs: Restore warning to original location
mfisher87 May 14, 2024
f019a3b
docs: Clarify instructional language
mfisher87 May 14, 2024
5988696
docs: Remove superfluous prose
mfisher87 May 14, 2024
62fd51e
docs: One sentence per line
mfisher87 May 14, 2024
5aca595
simplify contraction
agilgur5 May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,18 @@ For quick testing, you can use a local cluster with:

## Install Argo Workflows

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.
First, specify the version you want to install in an environment variable.
Modify the command below:

Below is an example of the install commands (substitute `<<ARGO_WORKFLOWS_VERSION>>` with the version number):
```bash
ARGO_WORKFLOWS_VERSION="vX.Y.Z"
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
```

Then, copy the commands 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<<ARGO_WORKFLOWS_VERSION>>/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
Expand Down