Add Juliaup docs #50477
Add Juliaup docs #50477
Conversation
doc/src/manual/juliaup.md
Outdated
| @@ -0,0 +1,12 @@ | |||
| # [Juliaup](@id man-juliaup) | |||
|
|
|||
| Juliaup is the official installer for Julia, enabling you to easily update and switch between Julia versions. | |||
There was a problem hiding this comment.
Should this file really be here? It seems to me it would make more sense to have a dedicated Juliaup manual, part of the Juliaup repository https://github.com/JuliaLang/juliaup and then link to that?
There was a problem hiding this comment.
Yeah that makes sense to me.
There was a problem hiding this comment.
I think from a user point of view I really dislike it when documentation is spread-out, e.g. the fact that the Pkg.jl docs aren't just in the Julia manual in my mind is really not user friendly. Sooo, I think it would be really much better if the docs are just part of the Julia manual, way easier to find for users. BUT, I'm going to remove this for now, so that we can at least merge the first part of this PR here.
|
@davidanthoff perhaps if there are sections of this that need further work, they could be deferred to a followup PR? |
|
@IanButterworth, yes, lets merge what is done, and I'll open a new PR with more docs later. This is now ready for review. |
|
CI error |
| To install Julia via Rust's cargo, run: | ||
|
|
||
| ```sh | ||
| cargo install juliaup | ||
| ``` |
There was a problem hiding this comment.
The text says: "To install Julia via Rust's cargo, run:" but then gives a command to install juliaup. A non-experienced reader at this point might expect Julia to already be installed.
How about this:
| To install Julia via Rust's cargo, run: | |
| ```sh | |
| cargo install juliaup | |
| ``` | |
| To install Juliaup via Rust's cargo, run: | |
| ```sh | |
| cargo install juliaup | |
| ``` | |
| Afterwards run `juliaup` -- you may pass any of the command line arguments described above. |
I guess the same also applies to the OpenSUSE and (home)brew sections -- and to a degree also the Arch one, which correctly states that it describes how to install Juliaup, but the user reading this wants to install Julia.
There was a problem hiding this comment.
I added some language at the top of the alternative methods section, I think that might be good enough?
In any case, I think we should just merge this at this point, and then folks can open follow up PRs that refine the lanugage.
No description provided.