Docs bug: following the quick-start guide _too_ explicitly can get users in trouble #13032
Closed
4 tasks done
Labels
area/docs
Incorrect, missing, or mistakes in docs
P3
Low priority
solution/suggested
A solution to the bug has been suggested. Someone needs to implement it.
type/bug
Milestone
Pre-requisites
:latest
image tag (i.e.quay.io/argoproj/workflow-controller:latest
) and can confirm the issue still exists on:latest
. If not, I have explained why, in detail, in my description below.What happened/what did you expect to happen?
Today I followed the quick start guide, and had trouble specifically with this part:
I did this, which led to me applying
install.yaml
, notquick-start-minimal.yaml
, which I think is what is intended for the quick-start guide. Therefore, when I did the hello-world step, I encountered:This is because the hello-world step depends on resources defined in
quick-start-minimal.yaml
.The example command immediately following this instruction does use the correct filename
quick-start-minimal.yaml
, but I ignored that example command for a few reasons:v<<ARGO_WORKFLOWS_VERSION>>
, so it's not directly copyable.Proposed resolution
Replace the language "execute the kubectl commands" with "navigate to
quick-start-minimal.yaml
, right click, and select 'copy link' to get the correct YAML URL. Craft akubectl
command to apply that yaml following this example: ..."Or:
Replace the language "execute the kubectl commands" with "to find example kubectl commands."
Add a mkdocs callout of type "danger": "Do not directly execute those commands, as we do not want to apply
install.yaml
. Instead, we want to usequick-start-minimal.yaml
. Here's an example command: ..."Version
v3.5.6
Paste a small workflow that reproduces the issue. We must be able to run the workflow; don't enter a workflows that uses private images.
Follow quick start guide following instructions too explicitly
Logs from the workflow controller
Logs from in your workflow's wait container
The text was updated successfully, but these errors were encountered: