Update README with curl instructions for Kedge download #165
Conversation
README.md
Outdated
| sudo mv ./kedge /usr/local/bin/kedge | ||
| ``` | ||
|
|
||
| You can also download Kedge via Go: |
There was a problem hiding this comment.
Shouldn't this say download and build?
cdrage
force-pushed
the
update-readme-install
branch
from
1be88b4 to
6faf432
Compare
|
@kadel Yeah, it should. Updated! |
README.md
Outdated
| curl -L https://dl.bintray.com/kedgeproject/kedge/latest/kedge-windows-amd64.exe -o kedge | ||
|
|
||
| chmod +x kedge | ||
| sudo mv ./kedge /usr/local/bin/kedge |
There was a problem hiding this comment.
is this path available on windows?
There was a problem hiding this comment.
We can take some inspiration from here https://github.com/kubernetes/minikube/releases/tag/v0.20.0
There was a problem hiding this comment.
for that matter from here https://github.com/kubernetes/minikube#installation
There was a problem hiding this comment.
No, it's not, instructions will only work for macOS or Linux, but leaving those instructions there would be fine.
There was a problem hiding this comment.
Maybe we can just add separate instructions for Windows. And also link to https://curl.haxx.se/download.html where the user can find curl for Windows.
There was a problem hiding this comment.
I'm +1 for having separate blocks of instructions for different OS like done in the minikube link above
README.md
Outdated
| # Windows | ||
| curl -L https://dl.bintray.com/kedgeproject/kedge/latest/kedge-windows-amd64.exe -o kedge | ||
|
|
||
| chmod +x kedge |
There was a problem hiding this comment.
is this possible on windows and mac?
There was a problem hiding this comment.
Yes it will work on macOS, see how https://kubernetes.io/docs/tasks/tools/install-kubectl/ does it as well. chmod and curl is available on mac.
README.md
Outdated
| Or you can build it yourself from the master GitHub branch: | ||
| ```sh | ||
| # Linux | ||
| curl -L https://dl.bintray.com/kedgeproject/kedge/latest/kedge-linux-amd64 -o kedge |
There was a problem hiding this comment.
In #162 (comment), I meant something like what minikube does here - https://github.com/kubernetes/minikube#linux
Basically an all in one command, which downloads, renames, sets permissions and puts in $PATH
There was a problem hiding this comment.
I prefer having it in multiple commands, as its easier to understand what is happening.
There was a problem hiding this comment.
I agre with @kadel , I take the inspiration from https://kubernetes.io/docs/tasks/tools/install-kubectl/ in regards to our instructions.
There was a problem hiding this comment.
Okay, it just makes it very easy for me to update minikube for me just copy pasting that thing, but I'm fine with any way.
|
Hey @surajssd @kadel @containscafeine I take inspiration by how https://kubernetes.io/docs/tasks/tools/install-kubectl/ does it in regards to their kubectl installation. Following how other projects from the incubator / k8s project does it. Makes sense having multiple commands as well instead of an all-in-one command / |
|
@cdrage so what are you exactly planning to do here? |
|
@surajssd I'd suggest an alternative way of how to deploy Windows, but otherwise, I don't think we should change anything (except Windows portion). Keep it similar to https://kubernetes.io/docs/tasks/tools/install-kubectl/ Any suggestions? |
|
@cdrage yes SGTM, change only windows and keep rest similar |
cdrage
force-pushed
the
update-readme-install
branch
from
6faf432 to
c3135db
Compare
|
@surajssd Updated. |
README.md
Outdated
| curl -L https://dl.bintray.com/kedgeproject/kedge/latest/kedge-darwin-amd64 -o kedge | ||
|
|
||
| # Windows | ||
| curl -L https://dl.bintray.com/kedgeproject/kedge/latest/kedge-windows-amd64.exe -o kedge |
There was a problem hiding this comment.
standard windows installation doesn't have curl :-(
README.md
Outdated
|
|
||
| # Windows | ||
| # Copy kedge to your %GOPATH/bin directory | ||
| move kedge %GOPATH%/bin/kedge |
There was a problem hiding this comment.
This is assuming that user has golang installed. Most users won't have that.
There was a problem hiding this comment.
For windows, it might be better to have just plain English sentence explaining what to do, and leave to rest on the user.
similarly to whats in minikube or kubectl :
Download the [kedge-windows-amd64.exe][Bintray Latest Windows] file, rename it to kedge.exe and add it to your PATH.
Updates the README with `curl` instructions rather than using binary links.
cdrage
force-pushed
the
update-readme-install
branch
from
c3135db to
785f472
Compare
|
@kadel Please review again, I've updated the docs. Hopefully the last time for updating! Added separate Windows instructions. |
Updates the README with
curlinstructions rather than using binarylinks.