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: add 'how to install' to argo-cli #9412

Closed
wants to merge 1 commit into from

Conversation

asfaltboy
Copy link

@asfaltboy asfaltboy commented Aug 22, 2022

Context

I was missing this bit of information when I got to this page. Also includes a reference of using homebrew.

Testing

Checked the markdown renders in github.

Going to try and rely on CI to make docs, if that doesn't happen will update with testing strategy.

Update: need to address the failing "spelling check"

I was missing this bit of information when I got to this page

Signed-off-by: Pavel Savchenko <asfaltboy@gmail.com>
Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if the changes are necessary. The installation instruction is here: https://github.com/argoproj/argo-workflows/blob/83fa63794a958881a2cd24182a4f101889d68f15/docs/installation.md

It refers to more specific links to install from releases.

@asfaltboy
Copy link
Author

The installation instruction is here

I know this is pretty basic. My goal is to improve the discoverability. I wanted to install the CLI tool, and searching through the docs brought me to this page, not the release page. Note that the release page doesn't mention Argo CLI, and I was less likely to follow to that page (I didn't need to install argo server or controller)

Would it better if the page should instead instruct users to refer to the releases.md page for up to date instructions (to avoid maintaining two methods of downloading)? Happy to change it if this makes sense, could also add a note there about what's available on the releases page.

On a related note, do you think the release notes should also mention homebrew, or you feel it's better to instruct users to download the pre-compiled binary as we do today?

@stale

This comment was marked as resolved.

@stale stale bot added the problem/stale This has not had a response in some time label Sep 20, 2022
@asfaltboy asfaltboy closed this Sep 21, 2022
@agilgur5
Copy link
Contributor

agilgur5 commented Sep 5, 2023

Recreated in #11751

Would it better if the page should instead instruct users to refer to the releases.md page for up to date instructions (to avoid maintaining two methods of downloading)? Happy to change it if this makes sense, could also add a note there about what's available on the releases page.

I suggested adding a link to the GH Releases page in that PR, which was accepted

@agilgur5 agilgur5 added area/cli The `argo` CLI area/docs Incorrect, missing, or mistakes in docs labels Sep 5, 2023
@agilgur5 agilgur5 removed the problem/stale This has not had a response in some time label Sep 5, 2023
@agilgur5 agilgur5 added the solution/superseded This PR or issue has been superseded by another one (slightly different from a duplicate) label Feb 17, 2024
@argoproj argoproj locked as resolved and limited conversation to collaborators Jun 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/cli The `argo` CLI area/docs Incorrect, missing, or mistakes in docs solution/superseded This PR or issue has been superseded by another one (slightly different from a duplicate)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants