-
Notifications
You must be signed in to change notification settings - Fork 130
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
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
22afa50
Update docs for Zui name change & Docusaurus
92cb042
Fix merge conflict
philrz 8c3e564
Update docs for move to macos-12 for builds
philrz f906234
Fix merge conflicts
philrz ec4a0a0
Drop link to removed article on Importing Parquet and ZST
philrz 7c8edf3
Assume Zui v1.0.0 will come with Zed v1.6.0
philrz e0b3a22
Support article for Brim/Zui transition
philrz 6699be4
PR feedback: Move pcap processing tip
philrz 8163481
New transition guidance due to #2681
philrz dc10153
Prep for wiki migration merge
philrz 3b4a244
Merge branch 'main' into zuifi-wiki
philrz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| name: Notify docs update | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - zuifi-wiki | ||
| 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"}' |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| sidebar_label: Introduction | ||
| --- | ||
|
|
||
| # The Zui Desktop Application | ||
|
|
||
| Zui (formerly called Brim) is a graphical user interface for exploring data in | ||
| [Zed lakes](https://zed.brimdata.io/docs/commands/zed). While these docs are | ||
| specific to the Zui app experience, you may want to browse the separate | ||
| [docs for the Zed project](https://zed.brimdata.io/docs) on topics such as: | ||
|
|
||
| * the [Zed language](https://zed.brimdata.io/docs/language) that's used in Zui for queries and analytics, | ||
| * the [command-line tools](https://zed.brimdata.io/docs/commands) that work alongside Zui, and | ||
| * the [Zed data formats](https://zed.brimdata.io/docs/formats). | ||
|
|
||
| :::tip pcap processing | ||
| Functionality related to pcap processing (including the generation of Zeek and | ||
| Suricata summary logs from pcaps and pcap import/extraction workflows) is | ||
| handled by [Brimcap](https://github.com/brimdata/brimcap), which is bundled | ||
| with Zui. A separate [Brimcap wiki](https://github.com/brimdata/brimcap/wiki) | ||
| contains current docs related to pcap processing. | ||
| ::: | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Trying out Zui is easy: just [install](./Installation.md) the package for | ||
| your operating system. Once you launch the app, click **Import Data** | ||
| on the welcome screen and drag & drop a file of one of the formats | ||
| shown. Simple operations such as filtering and "count by" are available in a | ||
| menu that appears when you right-click on values in your data. When you're ready | ||
| to perform more sophisticated queries and aggregations, consult the | ||
| [Zed language](https://zed.brimdata.io/docs/language) docs. | ||
|
|
||
| ## Behind the Name Change | ||
|
|
||
| When Brim began as a company, we intended to build a security-focused desktop | ||
| application powered by our backend called [Zed](https://zed.brimdata.io/). The | ||
| company's main product was the app, so we called it the Brim app. | ||
|
|
||
| As we developed Zed, we started to realize we had something big on our hands. | ||
| Zed's data model, language, query engine, and storage formats provided | ||
| revolutionary new ways to work with all kinds of data. In April 2021, we | ||
| decided to pivot, making Zed the company's flagship technology. Brim Security | ||
| became [Brim Data](https://www.brimdata.io/). | ||
|
|
||
| This change made us question the purpose of the app. We were now leading with | ||
| the [Zed lake](https://zed.brimdata.io/docs/commands/zed), so we decided | ||
| the app would support the lake. Users would be able to explore a lake's data | ||
| and manage its configuration with the app. It would be a GUI for Zed. | ||
|
|
||
| At this point, having the app named after the company was confusing. We needed | ||
| a name that clearly tied the app to Zed. After many fun naming sessions, we | ||
| played off the word "GUI" and landed on "Zui": Zed user interface. | ||
|
|
||
| ## Zui Insiders | ||
|
|
||
| While GA versions of Zui will be released periodically, it's evolving fast. | ||
| If you're interested in keeping up with the very latest enhancements and bug | ||
| fixes, you can download the | ||
| [Zui - Insiders](https://github.com/brimdata/zui-insiders) app. It can run | ||
| side-by-side with regular Zui, stores data in a different location, and runs | ||
| the Zed lake service on a different port. It receives automatic updates every | ||
| weekday built from the tip of our `main` Zui branch. This is our take on a beta | ||
| program. If you find bugs or think of improvements, please chime in on the | ||
| [#zui-insiders](https://brimdata.slack.com/archives/C03MW6XT7HC) Slack channel. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this callout should be at the bottom of the page. It might be jarring for a first time user to see the words "zeek", "suricata" and "pcaps" so soon. They might think Zui is not relevant to them.
But if were at the bottom after the info on the name change, it would seem appropriate.