Installation feedback
epage opened this issue · comments
Split out from cobalt-org/cobalt.rs#179
@ ethagnawl
The user can be presented with the (preferred) option of installing via cargo
I just installed Cobalt for the first time and had this same thought. I was able to find the package on https://crates.io and install it using
cargo install cobalt-bin, but a snippet or link would be very helpful. It would reduce friction and prevent users from accidentally installing the other cobalt package.
@ethagnawl so to clarify, this issue is about no relying on a third party for some of our install instructions but it sounds like instead you didn't find our install instructions? If so, we should move this to a separate issue. I'll go ahead and reply here, assuming that is the case, in hopes to reduce some back and forth.
We have install instructions at https://cobalt-org.github.io/docs/install/
- Would those have resolved your concerns
- If so, what got in the way of using them?
- How did you hear about cobalt? Did it link out to anything?
- What led you to crates.io?
- Is there something we could do to make the "User documentation" link more attractive
Sorry to hijack the issue, @epage. I only chimed in here because my concern and its solution were mentioned.
Would those have resolved your concerns
No. I did find the install instructions, but wanted to use cargo instead of downloading and running a script hosted by a third party (at least, one that isn't the de facto third party). I also did not see any mention in the instructions of using cargo to install the application -- without building it from source.
I'll respond to your conditional questions because my answers may be useful to you all.
How did you hear about cobalt? Did it link out to anything?
A DuckDuckGo search for "rust static site generator".
What led you to crates.io?
Habit.
Is there something we could do to make the "User documentation" link more attractive
No. I don't think that's an issue.
Happy to continue the conversation in a new issue if you think it's worthwhile. I'm really enjoying the program so far. Thanks for your efforts!
I also did not see any mention in the instructions of using cargo to install the application -- without building it from source.
While there has been talk of some form of build caching, as far as I know installing with cargo effectively means building from source since it is meant as a build system and not an installation method.
No. I did find the install instructions, but wanted to use cargo instead of downloading
I feel I'm missing something between this comment and the original post:
a snippet or link would be very helpful. It would reduce friction and prevent users from accidentally installing the other cobalt package.
We do talk about installing from source on the website
https://cobalt-org.github.io/docs/install/
Wait, you are asking for install instructions for cargo to install directly from crates.io and not by cloning the repo? Is that the part I was originally missing?
Wait, you are asking for install instructions for cargo to install directly from crates.io and not by cloning the repo? Is that the part I was originally missing?
Yes, yes and yes.
I'm suggesting adding a note to the "install docs" (possibly under a new subsection called "Crates.io" or something) which says something like, "You can build/install the Cobalt binary (from crates.io) using cargo install cobalt-bin."