FairwindsOps / reckoner

Declaratively install and manage multiple Helm chart releases
https://fairwinds.com
Apache License 2.0
340 stars 33 forks source link

Documentation: Quickstart Installation instructions are unclear #686

Open tofarr opened 1 month ago

tofarr commented 1 month ago

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

Code of Conduct

Additional context

No response

sudermanjr commented 1 month ago

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!

kaincosta commented 3 weeks ago

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