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

Ensure Brim user can find ZQL docs #529

Closed
philrz opened this issue Apr 1, 2020 · 2 comments
Closed

Ensure Brim user can find ZQL docs #529

philrz opened this issue Apr 1, 2020 · 2 comments

Comments

@philrz
Copy link
Contributor

philrz commented Apr 1, 2020

A user made the suggestion on Slack:

oh yeah, you guys should have a link to the query syntax somewhere in the brim app
i wasn't sure what i could type into the search box

I'd been thinking users would have come to the app after having sat through the demo video and heard about the dependency on zq/ZQL, the pointers to the repos with the language docs, etc. But the user's experience is validation that not all will be that thorough/patient (duh!)

Can we add some kind of prominent link near the search box to https://github.com/brimsec/zq/tree/master/zql/docs?

Adding also the link to query language as a new list item in the Help area is useful.

help2.jpg

@philrz philrz changed the title Prominent link in app to ZQL docs Ensure Brim user can find ZQL docs Apr 6, 2020
@siskojr
Copy link

siskojr commented Apr 23, 2020

I got similar queries by two more users.

Adding request to included in help section as part of @philrz description for completeness.

For reference as a familiar method for users, Wireshark provides help on the filter with a right-click action in the search pane

wireshark.jpg

r-franke added a commit to r-franke/brim that referenced this issue Jul 2, 2020
@philrz
Copy link
Contributor Author

philrz commented Jul 21, 2020

Verified in Brim commit 93ffb60. Per the attached video, the ZQL docs are now available via Help > Query Syntax Docs.

Verify.mov.zip

Thanks @r-franke!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants