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.

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

docs: change quick-start guide to use quick-start install. Fixes #12391 #12445

Merged
merged 1 commit into from
Jan 3, 2024

Conversation

cardoe
Copy link
Contributor

@cardoe cardoe commented Jan 2, 2024

The quick start guide used the regular install.yaml for installation which does not configure the default user to be a valid service account to execute a workflow. This causes any example executions to fail. However the quick-start-minimal.yaml installation does configure this and is clearly suited for this doc so switch to that.

Fixes #12391

Verification

Redid the quick start guide with the quick-start-minimal.yaml installation and it worked.

The quick start guide used the regular install.yaml for installation
which does not configure the default user to be a valid service
account to execute a workflow. This causes any example
executions to fail. However the quick-start-minimal.yaml
installation does configure this and is clearly suited for this
doc so switch to that. fixes argoproj#12391

Signed-off-by: Doug Goldstein <cardoe@cardoe.com>
@terrytangyuan terrytangyuan merged commit bedd47f into argoproj:main Jan 3, 2024
15 checks passed
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Jan 3, 2024
hittingray pushed a commit to atlassian-forks/argo-workflows that referenced this pull request Jan 4, 2024
…proj#12391 (argoproj#12445)

Signed-off-by: Doug Goldstein <cardoe@cardoe.com>
Signed-off-by: Raymond Chow <rchow@atlassian.com>
hittingray pushed a commit to atlassian-forks/argo-workflows that referenced this pull request Jan 4, 2024
…proj#12391 (argoproj#12445)

Signed-off-by: Doug Goldstein <cardoe@cardoe.com>
Signed-off-by: Raymond Chow <rchow@atlassian.com>
@dgolja
Copy link

dgolja commented May 7, 2024

Is there a reason why this documentation was not updated yet on the main page https://argo-workflows.readthedocs.io/en/stable/quick-start/ ? This update could save a lot of time to new users.

@agilgur5
Copy link
Member

@dgolja we didn't have versioned documentation until very recently (#11390), so backporting docs was not part of the process previously.
Also, ReadTheDocs only recently added the (very) large warning on older versions and latest.

For future reference, if you want something to be backported, the place to ask is in the release issue, in this case that's #11997.

I'm currently managing backports and releases for 3.5.x, so I'll do that right now

agilgur5 pushed a commit that referenced this pull request May 11, 2024
… (#12445)

Signed-off-by: Doug Goldstein <cardoe@cardoe.com>
(cherry picked from commit bedd47f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

quick start fails out of the box due to RBAC error
4 participants