Skip to content

Commit 4c3deae

Browse files
authored
Docs for new Update features (#2950)
Docs for new Updates features
1 parent 080258f commit 4c3deae

File tree

3 files changed

+41
-17
lines changed

3 files changed

+41
-17
lines changed

apps/zui/docs/Installation.md

+41-17
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,8 @@ Once installed, no additional configuration is necessary. For your reference,
2121
a separate article describes the [filesystem paths](./support/Filesystem-Paths.md) where unpacked Zui
2222
binaries and saved user data are stored on each platform.
2323

24-
Details are provided in each section below about when Zui may "auto-update" to
25-
newer releases and when manual upgrades are necessary. In all cases,
26-
updating to a newer version of the app will preserve your existing
27-
[user data](./support/Filesystem-Paths.md#user-data). Because the way user data
28-
is stored sometimes changes in newer releases, downgrades to older releases are
29-
_not_ currently supported.
24+
Zui checks over the network for newer releases that may be available for
25+
[update](#updates).
3026

3127
If you run into any problems, you may want to browse the
3228
[troubleshooting docs](./support/Troubleshooting.md). If you get stuck, [join our public Slack](https://www.brimdata.io/join-slack/)
@@ -39,25 +35,21 @@ and we'll be happy to help.
3935
* Choose between installing for only the current user (default) or a machine-wide install
4036
* Click **Finish** and Zui will launch when installation completes
4137
* Click the Zui icon on the Desktop or Start menu to relaunch in the future
38+
* Zui checks over the network for newer releases that may be available for [update](#updates)
4239

4340
![Windows Installation](media/Windows-installation.gif)
4441

45-
As newer Windows releases are published, Zui will automatically download them
46-
and pop up a notification offering to restart the app to apply the update.
47-
4842
## macOS Installation
4943

5044
* Download the Zui installer via the **macOS** link at the [Zui download](https://www.brimdata.io/download/) page
5145
* Launch the downloaded `.dmg` file to begin installation
5246
* Click and drag the Zui icon into the Applications folder
5347
* Click the Zui icon in the Applications folder to start Zui now and in the future
5448
* You may need to click through an "Are you sure?" prompt the first time Zui is launched
49+
* Zui checks over the network for newer releases that may be available for [update](#updates)
5550

5651
![macOS Installation](media/macOS-installation.gif)
5752

58-
As newer macOS releases are published, Zui will automatically download them
59-
and pop up a notification offering to restart the app to apply the update.
60-
6153
## Linux Installation
6254

6355
* Uninstall any currently-installed Zui release, using a tool like `yum`,
@@ -72,11 +64,43 @@ and pop up a notification offering to restart the app to apply the update.
7264
* Open the downloaded `.deb` or `.rpm` file in the Software Install utility and click **Install**
7365
* Enter administration credentials, if prompted
7466
* Click the Zui icon in the applications menu to start the app now and in the future
67+
* Zui checks over the network for newer releases that may be available for [update](#updates)
7568

7669
![Linux Installation](media/Linux-installation.gif)
7770

78-
As newer Linux releases are published, Zui will pop up a notification of their
79-
availability, but the Linux releases do _not_ auto-update. Follow the link in
80-
the pop-up to the [Zui download](https://www.brimdata.io/download/) page to
81-
get the latest release. After uninstalling the prior version, install the new
82-
release using the appropriate package manager for your distribution.
71+
## Updates
72+
73+
In a default configuration, each time Zui is launched it will check over the
74+
network for the availability of a newer release. If one is found, a
75+
notification like the following will pop up.
76+
77+
![Update Available](media/Update-Available.png)
78+
79+
If **Later** is clicked, the notification is dismissed and no update is
80+
performed. If **Install** is clicked, the result on each platform is as follows:
81+
82+
|**Platform**|**Result**|
83+
|-|-|
84+
|**Windows**|An interactive wizard for the newer release will launch, just like the one from initial [installation](#windows-installation).|
85+
|**macOS**|The newer release will install in the background and Zui will automatically relaunch into the newer version.|
86+
|**Linux**|The [Zui download](https://www.brimdata.io/download/) page will open in your browser. Manual uninstall/reinstall is necessary on Linux, so repeat the same download/uninstall/reinstall steps as during initial [installation](#linux-installation).|
87+
88+
In all cases, updating to a newer version of the app will preserve your existing
89+
[user data](./support/Filesystem-Paths.md#user-data). Because the way user data
90+
is stored can sometimes change in newer releases, downgrading to older releases is
91+
_not_ currently supported.
92+
93+
Configurable **Settings** are available to change notification frequency.
94+
95+
![Updates Settings](media/Updates-Settings.png)
96+
97+
|**Setting**|**Result**|
98+
|-|-|
99+
|**On Startup** (default)|A check is performed for a newer release once each time Zui is launched|
100+
|**On Startup & Daily**|A check is performed for a newer release when Zui is launched and every 24 hours thereafter that the app remains open|
101+
|**Manually**|Zui will never pop up an automatic notification about a newer release|
102+
103+
Regardless of settings, manually clicking the pull-down menu option
104+
**Help > Check for Updates** on Windows/Linux or **Zui > Check for Updates**
105+
on macOS will perform an immediate check and a notification will pop up if a newer
106+
release is detected.
14.1 KB
Loading
64.5 KB
Loading

0 commit comments

Comments
 (0)