Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for Zui name change & Docusaurus #2531

Merged
merged 11 commits into from
Mar 3, 2023
21 changes: 0 additions & 21 deletions .github/workflows/docs-publish.yml

This file was deleted.

16 changes: 16 additions & 0 deletions .github/workflows/notify-docs-update.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Notify docs update

on:
push:
branches:
- main
paths:
- 'docs/**'

jobs:
build:
runs-on: ubuntu-20.04
steps:
- name: Send dispatch event
run: |
curl -XPOST -u "${{ secrets.PAT_USERNAME }}:${{ secrets.PAT_TOKEN }}" -H "Accept: application/vnd.github.v3+json" -H "Content-Type: application/json" https://api.github.com/repos/brimdata/zui-docs-site/dispatches --data '{"event_type":"zui-docs-update"}'
32 changes: 0 additions & 32 deletions docs/Home.md

This file was deleted.

61 changes: 0 additions & 61 deletions docs/Importing-Parquet-and-VNG.md

This file was deleted.

60 changes: 32 additions & 28 deletions docs/Installation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
---
sidebar_position: 2
sidebar_label: Installation
---

# Installation

Brim is an interactive desktop application for Windows, macOS, and Linux.
Zui is an interactive desktop application for Windows, macOS, and Linux.
To install, click the link at the
[Brim download](https://www.brimdata.io/download/) page for your platform
and double-click to launch the installer.
[Zui download](https://www.brimdata.io/download/) page for your platform
and double-click the downloaded package to launch the installer.

The notes and short videos below show how to successfully install on each
platform.
Expand All @@ -13,69 +18,68 @@ platform.
* [Linux Installation](#linux-installation)

Once installed, no additional configuration is necessary. For your reference,
a separate article describes the [[filesystem paths]] where unpacked Brim
a separate article describes the [filesystem paths](./support/Filesystem-Paths.md) where unpacked Zui
binaries and saved user data are stored on each platform.

Details are provided in each section below about when Brim may "auto-update" to
Details are provided in each section below about when Zui may "auto-update" to
newer releases and when manual upgrades are necessary. In all cases,
updating to a newer version of the app will preserve your existing
[user data](https://github.com/brimdata/brim/wiki/Filesystem-Paths#user-data). As the way user data
[user data](./support/Filesystem-Paths.md#user-data). Because the way user data
is stored sometimes changes in newer releases, downgrades to older releases are
_not_ currently supported.

For a walk through some typical operations in Brim to get started, watch the
[Brim Demo video](https://www.youtube.com/watch?v=InT-7WZ5Y2Y).
For a walk through some typical operations in Zui to get started, watch the
[Zui demo video](https://www.youtube.com/watch?v=InT-7WZ5Y2Y).

If you run into any problems, you may want to browse the
[wiki articles](https://github.com/brimdata/brim/wiki), perhaps starting with
[[Troubleshooting]]. If you get stuck, [join our public Slack](https://www.brimdata.io/join-slack/)
If you run into any problems, you may want to browse the
[troubleshooting docs](./support/Troubleshooting.md). If you get stuck, [join our public Slack](https://www.brimdata.io/join-slack/)
and we'll be happy to help.

## Windows Installation

* Download the Brim installer via the Windows link at the [Brim download](https://www.brimdata.io/download/) page
* Download the Zui installer via the Windows link at the [Zui download](https://www.brimdata.io/download/) page
* Launch the downloaded `.exe` file to begin installation
* When prompted, click "I Agree" to accept the terms of the license agreement
* Brim will start automatically when install completes
* Click the Brim icon on the Desktop or Start menu to relaunch in the future
* Zui will start automatically when install completes
* Click the Zui icon on the Desktop or Start menu to relaunch in the future

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

As newer Windows releases are published, Brim will automatically download them
As newer Windows releases are published, Zui will automatically download them
and pop up a notification offering to restart the app to apply the update.

## macOS Installation

* Download the Brim installer via the macOS link at the [Brim download](https://www.brimdata.io/download/) page
* Download the Zui installer via the macOS link at the [Zui download](https://www.brimdata.io/download/) page
* Launch the downloaded `.dmg` file to begin installation
* Drag the Brim icon into the Applications folder
* Click the Brim icon in the Applications folder to start Brim now and in the future
* You may need to click through an "Are you sure?" prompt the first time Brim is launched
* Drag the Zui icon into the Applications folder
* Click the Zui icon in the Applications folder to start Zui now and in the future
* You may need to click through an "Are you sure?" prompt the first time Zui is launched

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

As newer macOS releases are published, Brim will automatically download them
As newer macOS releases are published, Zui will automatically download them
and pop up a notification offering to restart the app to apply the update.

## Linux Installation

* Uninstall any currently-installed Brim release, using a tool like `yum`,
* Uninstall any currently-installed Zui release, using a tool like `yum`,
`dnf`, or `apt` (saved data and settings will not be disturbed by uninstall,
as these are stored under a
[user data](https://github.com/brimdata/brim/wiki/Filesystem-Paths#user-data)
[user data](./support/Filesystem-Paths.md#user-data)
path that's separate from the
[application binaries](https://github.com/brimdata/brim/wiki/Filesystem-Paths#application-binaries))
* Download either the `.deb` or `.rpm` Brim installer at the
[Brim download](https://www.brimdata.io/download/) page, as appropriate
[application binaries](support/./Filesystem-Paths.md#application-binaries))
* Download either the `.deb` or `.rpm` Zui installer at the
[Zui download](https://www.brimdata.io/download/) page, as appropriate
for your Linux distribution
* Open the downloaded `.deb` or `.rpm` file in the Software Install utility and click "Install"
* Enter administration credentials, if prompted
* Click the Brim icon in the applications menu to start the app now and in the future
* Click the Zui icon in the applications menu to start the app now and in the future

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

As newer Linux releases are published, Brim will pop up a notification of their
As newer Linux releases are published, Zui will pop up a notification of their
availability, but the Linux releases do _not_ auto-update. Follow the link in
the pop-up to the [Download](https://www.brimdata.io/download/) page to
the pop-up to the [Zui download](https://www.brimdata.io/download/) page to
get the latest release and update it using the appropriate package manager for
your distribution.
65 changes: 0 additions & 65 deletions docs/Joining-Data.md

This file was deleted.

41 changes: 0 additions & 41 deletions docs/Migration-for-Version-0.29.md

This file was deleted.

Loading