argo-workflows icon indicating copy to clipboard operation
argo-workflows copied to clipboard

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

Open mfisher87 opened this issue 1 month ago • 2 comments

I got hung up on these instructions because I copied the commands from the releases page instead of from the quick start page, so I applied install.yaml instead of quick-start-minimal.yaml. I hope this change will help others not get confused like me :)

I tried make pre-commit -B (had to install go first) and it failed with protoc not found. Do I need to keep working my way through these, or is it OK to ignore for a docs change like this?

Fixes #13032

Motivation

I followed the quick start instructions explicitly, but ended up with an install that couldn't execute Hello World step.

Modifications

Alter docs to explicitly instruct the user to install the quick start manifest.

I also moved a warning admonition because I felt it belonged after prose I added in this PR.

Verification

Rendered the docs, looked good

mfisher87 avatar May 14 '24 01:05 mfisher87

Apologies, knew I should have opened as a draft but clicked too hastily and missed the little arrow on the button.

mfisher87 avatar May 14 '24 01:05 mfisher87

I tried make pre-commit -B (had to install go first) and it failed with protoc not found. Do I need to keep working my way through these, or is it OK to ignore for a docs change like this?

It's not necessary for most of the docs, only the codegen'd ones. CI passes so you're good. Also, the Makefile defines protoc 🤔

agilgur5 avatar May 14 '24 03:05 agilgur5

Great, thanks for confirming! Happy to make any changes or rebase or whatever :)

mfisher87 avatar May 14 '24 15:05 mfisher87

Yea I was gonna request some small changes when I was at my computer (previous comments were from my phone). Should be done later today

agilgur5 avatar May 14 '24 15:05 agilgur5

Thanks for your time, Anton :heart:

Just want to say I'm really impressed with the community y'all have built here :star_struck:

mfisher87 avatar May 14 '24 15:05 mfisher87