Skip to content

Commit

Permalink
more update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
aviatesk committed Feb 28, 2020
1 parent fc5de2d commit 889fa00
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/src/devdocs/contributor_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This project is composed of many sub-projects, and it can be hard to know the appropriate
place to file issues. For that reason, we prefer that non-developers report issues
on [Juno.jl GitHub repository](https://github.com/JunoLab/Juno.jl/issues) or
at [Julia's discussion forum under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest).
at [Julia Discourse under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest).
If you know which package the issue is appropriate in, then please open an issue there.
Bug reports can be some of the most helpful contributions!

Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ When you update your Juno, please first read through [Update Instructions](@ref)
If you have any issues with this setup, look up for a [FAQ](@ref) section first.
If it doesn't help, please do report them
on [Juno.jl GitHub repository](https://github.com/JunoLab/Juno.jl/issues) or
at [Julia's discussion forum under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest).
at [Julia Discourse under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest).
We'll do our best to help you get going.
You can also ping us on the `#juno-bridged` channel in [the Julia slack](https://slackinvite.julialang.org/)
to ask some random questions or for a chat.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/man/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Please leave bug reports either
on [Juno.jl GitHub repository](https://github.com/JunoLab/Juno.jl/issues) or
at [Julia's discussion forum under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest).
at [Julia Discourse under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest).

!!! note
When you report a problem, please add the output of `Julia Client: Debug Info` command or `Juno > Debug Information` menus entry if possible.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/man/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ or `Ctrl-J Ctrl-O` (`Cmd-J Cmd-O` on macOS), and then press `Enter` in the REPL
If you experience problems after installing Juno, have a look at the [FAQ](@ref) section.
In case you can't solve your problem with the instructions here or in the FAQ, then please post
on [Juno.jl GitHub repository](https://github.com/JunoLab/Juno.jl/issues) or
at [Julia's discussion forum under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest),
at [Julia Discourse under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest),
and we're happy to help.

!!! note
Expand Down
44 changes: 34 additions & 10 deletions docs/src/man/update.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# Update Instructions

To update your Juno, you need to follow the two steps -- both update Atom packages and Julia packages.
To update your Juno, you need to follow the two steps –
update both Atom packages and Julia packages,
each of which constitutes a part of Juno.


## 1. Update Atom Packages

In this step, we install the latest versions of
In this step, you install the latest versions of
[`julia-client`](https://github.com/JunoLab/atom-julia-client) and
[`ink`](https://github.com/JunoLab/atom-ink)
packages.

First, close all the Atom windows and type the following command into your terminal
First, _**close all the Atom windows**_.

And then type the following command into your terminal
(e.g. `cmd` on Windows or the Terminal App on MacOS):

```sh
apm update
```

If that also doesn’t work or if you want to only update Juno-related packages,
If that doesn’t work, or if you want to only update Juno-related packages,
try the commands below instead:

```sh
Expand All @@ -30,7 +34,7 @@ apm install julia-client
!!! note
To fully update Atom packages, an Atom process that had been started _before_ updating the packages needs to be restarted.
This is why we recommend you close all the Atom processes first.
If you follow the above step, `julia-client` and `ink` will be the latest version the next time you open Atom .
If you follow the above step, `julia-client` and `ink` will be latest the next time you open Atom .

!!! warning
It is possible that your Antivirus Software prevents certain files to be downloaded or
Expand All @@ -44,16 +48,18 @@ apm install julia-client

## 2. Update Julia Packages

Execute the following in a Julia prompt:
Now you update Julia packages:
[Atom.jl](https://github.com/JunoLab/Atom.jl) and
[Juno.jl](https://github.com/JunoLab/Juno.jl).

Start a Julia process _**outside of Juno**_, and then execute the following:

```julia
pkg> up Atom Juno
```

If it doesn't work, try to execute below and see what hinders the updates of
[Atom.jl](https://github.com/JunoLab/Atom.jl) and
[Juno.jl](https://github.com/JunoLab/Juno.jl)
in your environment.
Atom.jl and Juno.jl in your environment.

```julia
pkg> rm Atom Juno
Expand All @@ -63,16 +69,34 @@ pkg> add Juno@junojlver

where `@atomjlver` and `@junojlver` is the versions of Atom.jl and Juno.jl that you're trying to update to, respectively.

!!! tip
It is also possible to update Atom.jl and Juno.jl from Juno's REPL,
but in some update cases Juno's REPL itself may be unfunctional because of
the incompatibility between (already updated) Atom packages and (not-updated) Julia packages,
and so we recommend you update Julia packages outside of Juno.

Also note that when you update Julia packages from Juno's REPL
and if the `Boot Mode` config setting is set to `Cycler`,
you may need to restart Julia process _twice_ to reflect update changes.

!!! warning
The versioning of Atom.jl and Juno.jl doesn't necessarily match.
For example, the current latest version of Atom.jl is `[email protected]`
while that of Juno.jl is `[email protected]`

## 3. The New Juno is Ready !

Congrat ! Now your Juno has been successfully updated.
Let's start Atom, fire up Julia, and enjoy the new Juno !

We usually publish release notes at [Julia Discourse](https://discourse.julialang.org/c/tools/juno/l/latest);
please check there for what new features/improvements/bugfixes are included within a release.

## Troubleshooting

In a case you still face a problem even after following the update instructions here, then please post
on [Juno.jl GitHub repository](https://github.com/JunoLab/Juno.jl/issues) or
at [Julia's discussion forum under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest),
at [Julia Discourse under the `Tooling ▶ Juno` category](https://discourse.julialang.org/c/tools/juno/l/latest),
and we're happy to help.

!!! note
Expand Down

0 comments on commit 889fa00

Please sign in to comment.