Improve CLI install instructions #23134
Conversation
|
Thanks for your pull request! The title of your pull request does not follow our editorial rules. Could you have a look?
|
| * <<sdkman,SDKMAN!>> | ||
| * <<jbang,JBang>> for Linux, OSX and Windows (no java required) | ||
| * <<sdkman,SDKMAN!>> for Linux and OSX (java required) | ||
| * <<homebrew,Homebrew>> for OSX (java required) | ||
|
|
There was a problem hiding this comment.
While I agree with moving Homebrew down, I would perhaps leave SDKMan first unless you have resolved the trusted source issue with JBang, as that is confusing users.
Have you fixed the warning for JBang (re: maven central as source or some other means)? Edit: I see the other PRs now, and I have a comment on one of them.
There was a problem hiding this comment.
I decided to make them alphabetically sorted. And I would prefer we keep it that way. There's absolutely no way we can find an ordering that will fit all the users so alphabetical is probably the best.
There was a problem hiding this comment.
Is it OSX or macOS? Also make sure Java is capitalized
There was a problem hiding this comment.
I agree with @ebullient on leaving SDKMan first. IMHO we should promote what works better and faster first instead of alphabetically.
|
|
||
| On Linux, macOS, and Windows (using WSL or bash compatible shell like Cygwin or MinGW) | ||
| [source,bash] | ||
| ---- | ||
| curl -Ls https://sh.jbang.dev | bash -s - trust add https://repo1.maven.org/maven2/io/quarkus/quarkus-cli/ |
There was a problem hiding this comment.
Can we add a comment re: what this does?
This step should be separated out and (briefly) explained. Ubuntu uses words like this to explain adding additional repos/keys (using installation of mongo as an example):
From a terminal, issue the following command to import the MongoDB public GPG Key from ...
wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -The operation should respond with an OK code.
Something like this (but about adding Quarkusio as a trusted source) would suffice.
| * <<jbang,JBang>> for Linux, OSX and Windows (no java required) | ||
| * <<sdkman,SDKMAN!>> for Linux and OSX (java required) | ||
| * <<homebrew,Homebrew>> for OSX (java required) |
There was a problem hiding this comment.
| * <<jbang,JBang>> for Linux, OSX and Windows (no java required) | |
| * <<sdkman,SDKMAN!>> for Linux and OSX (java required) | |
| * <<homebrew,Homebrew>> for OSX (java required) | |
| * <<jbang,JBang>> for Linux, macOS and Windows (no Java required) | |
| * <<sdkman,SDKMAN!>> for Linux and macOS (Java required) | |
| * <<homebrew,Homebrew>> for macOS (Java required) |
Details in quarkusio/quarkusio.github.io#1307 on why the "trust" call is added. I moved jbang up as it is the only one that works on every OS and without java first installed. Thus absolute fastest/simplest to use on all major OS's. And moved homebrew down as that is only available for mac/osx.
|
I think I came up with an acceptable compromise and also used tabs to present the alternatives. I will merge once CI is green and push it to the website. |
Details in quarkusio/quarkusio.github.io#1307
on why the "trust" call is added.
I moved jbang up as it is the only one that works on every OS and without
java first installed. Thus absolute fastest/simplest to use on all major OS's.
And moved homebrew down as that is only available for mac/osx.