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

Documentation: Quickstart Installation instructions are unclear #686

Open
2 tasks done
tofarr opened this issue Sep 11, 2024 · 2 comments
Open
2 tasks done

Documentation: Quickstart Installation instructions are unclear #686

tofarr opened this issue Sep 11, 2024 · 2 comments
Labels
bug Something isn't working documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@tofarr
Copy link

tofarr commented Sep 11, 2024

What happened?

All quick start instructions seem to start at the point where a user already has the cli downloaded, but I couldn't find specific instructions on how to actually install this tool. (Something like pip install reckoner or brew install reckoner?)

Do you have an installer? I have found folks doing...

curl -L "https://github.com/FairwindsOps/reckoner/releases/download/v6.0.0/reckoner_6.0.0_linux_amd64.tar.gz" > reckoner.tar.gz
tar -xvf reckoner.tar.gz
sudo mv reckoner /usr/local/bin/reckoner

But this seems environment specific. (And I'm trying on mac os and don't see a build for it.)

What did you expect to happen?

It would be nice to see instruction to install the tool

How can we reproduce this?

Go to:
https://github.com/FairwindsOps/reckoner?tab=readme-ov-file
or:
https://reckoner.docs.fairwinds.com/usage/#course-yaml-definition

There are no instructions on how to actually install this.

Version

6.0.0

Search

  • I did search for other open and closed issues before opening this.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Additional context

No response

@tofarr tofarr added bug Something isn't working triage This bug needs triage labels Sep 11, 2024
@sudermanjr
Copy link
Member

Since we have moved to a go binary, it's kind of up to the user how they would like to install it. We also have an asdf plugin - https://github.com/FairwindsOps/asdf-reckoner

Your way works as well too, and could be expanded to work with multiple architectures. If you would like to open a PR on the docs, please feel free. Thanks!

@sudermanjr sudermanjr added question Further information is requested and removed triage This bug needs triage labels Sep 20, 2024
@kaincosta
Copy link

You could still provide some instruction on how this is suppose to be installed.

@sudermanjr sudermanjr added help wanted Extra attention is needed good first issue Good for newcomers documentation and removed question Further information is requested labels Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants