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

[ES|QL] Increase discoverability of ES|QL (aka switcher) #184691

Closed
8 tasks
ryankeairns opened this issue Jun 3, 2024 · 10 comments · Fixed by #188898
Closed
8 tasks

[ES|QL] Increase discoverability of ES|QL (aka switcher) #184691

ryankeairns opened this issue Jun 3, 2024 · 10 comments · Fixed by #188898
Assignees
Labels
Feature:ES|QL Team:ESQL ES|QL related features in Kibana UX

Comments

@ryankeairns
Copy link
Contributor

ryankeairns commented Jun 3, 2024

This meta issue provides an overview of the next version of the ES|QL editor. It coincides with a new "switcher" button that will draw more users into using ES|QL.

Design <> Development handoff

Annotated Figma file
Prototype showing switching interaction

Proposed end state

1. Add new 'Try ES|QL' button in current default mode

(see next image)

2. Make the data view picker more clearly about data views

...and remove the current 'Language: ES|QL' button from the data view picker

3. Drop compressed editor

  • Remove the compressed ES|QL leaving only - what is today referred to as - the expanded editor and the inline editor used in Dashboard.

4. Make the expanded editor more editor-like

CleanShot 2024-07-22 at 16 32 26@2x

5. Introduce V1 of new 'file menu'

  • ES|QL reference link opens the existing in-product docs panel. This is meant to make it more discoverable and communicates the associated shortcut. I don't know how much work is involved in adding a shortcut... this is a nice-to-have.
  • About ES|QL opens the ES|QL page on our external docs site (https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html). I suppose this may need to be version specific like https://www.elastic.co/guide/en/elasticsearch/reference/8.13/esql.html ?
  • Switch to classic does just that. This essentially replaces the blue button seen atop the editor today.

CleanShot 2024-07-23 at 11 50 33@2x

What else will be in this menu?
Next up will likely be New and Save capabilities.
Over time, several other items could be added as demonstrated below (for example only; not to be taken too literally)

TODOs

Switcher + editor changes #182083

Related enhancements for informational purposes

  1. Feature:ES|QL Team:ESQL enhancement
  2. Feature:ES|QL Team:ESQL enhancement
@ryankeairns ryankeairns added Feature:ES|QL Team:ESQL ES|QL related features in Kibana labels Jun 3, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-esql (Team:ESQL)

@stratoula
Copy link
Contributor

stratoula commented Jun 4, 2024

@ryankeairns this is cool but I dont understand how it will look in Discover that has already the time picker and the Run button in the navigation 🤔 . Can you please share a screenshot on this integrated in various places such as Discover or inline editing of an ES|QL chart?

Update: I guess it will look like this?

image

@stratoula
Copy link
Contributor

stratoula commented Jun 4, 2024

@ryankeairns which is the difference from this issue #182083 I am trying to keep our backlog clean and I dont want to have duplicated content but if you feel that we need both is also ok. 👍

@ryankeairns
Copy link
Contributor Author

ryankeairns commented Jun 4, 2024

@ryankeairns which is the difference from this issue #182083 I am trying to keep our backlog clean and I dont want to have duplicated content but if you feel that we need both is also ok. 👍

Ah yes, that one was specific to just the switching mechanism even though it shows the other editor changes. I'll convert this issue to a meta, break it down into workable chunks, and create a small set of issues (e.g. fixes, moving buttons around, adding the switcher). This way, it will become more clear what can be worked on now (fixes) and if/when the other items are approved.

Sound good @stratoula ?

@stratoula
Copy link
Contributor

Sounds fantastic!

@ryankeairns ryankeairns changed the title [ES|QL] Tidy up editor UI [ES|QL] [META] Editor UI updates Jun 4, 2024
@ryankeairns ryankeairns added the UX label Jun 4, 2024
@ryankeairns
Copy link
Contributor Author

@ryankeairns this is cool but I dont understand how it will look in Discover that has already the time picker and the Run button in the navigation 🤔 . Can you please share a screenshot on this integrated in various places such as Discover or inline editing of an ES|QL chart?

Update: I guess it will look like this?

image

Right, like that. I will add that since writing up this issue, I have put together some additional ideas that utilize the existing bar/space above the editor (spoiler alert: it has to do with controls). We will review them tomorrow during our sync!

stratoula added a commit that referenced this issue Jun 7, 2024
## Summary

Part of #184691


```[tasklist]
### Things addressed
- [x] Fix double bottom border on header
- [x] Fix missing bottom border on footer/editor
- [x] Reduce left and right padding on header to 4px
- [x] Consolidate _Add/remove line breaks on pipes_ to a single icon (toggle between)
- [x] Fix 1px gap above editor footer
- [x] Changed the icon of the history component  
```
@stratoula stratoula self-assigned this Jun 12, 2024
@ryankeairns
Copy link
Contributor Author

@stratoula hold off on this one, please. I want to review some new designs with you/the team before we proceed. I have some things in mind for the possibility of controls and search that could leverage the space in the top bar.

@ryankeairns
Copy link
Contributor Author

We'll need to talk about this, of course, but an image helps illustrate an idea:

CleanShot 2024-06-13 at 14 52 14@2x

@stratoula
Copy link
Contributor

So we are not moving the time picker and run button in the editor but we are filling the gap with controls? Yes, I would love to discuss it in person 👍

@ryankeairns ryankeairns changed the title [ES|QL] [META] Editor UI updates [ES|QL] Increase discoverability of ES|QL (aka switcher) Jul 22, 2024
@ryankeairns
Copy link
Contributor Author

@stratoula I went ahead and split the two new additions to the info bar (aka footer) into separate issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:ES|QL Team:ESQL ES|QL related features in Kibana UX
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants