[7.x] [Lens] Document UI terminology (#72423) #74503
Conversation
💚 Build SucceededBuild metrics
To update your PR or re-run it, just comment with: |
There was a problem hiding this comment.
These are great! I think we can merge them with the Glossary, if you're okay with that.
I left my recommendations based on what we already have in the product docs, but if you disagree with anything, let me know and I can update what we have.
|
|
||
| Lens has a lot of UI elements – to make it easier to refer to them in issues or bugs, this is a hopefully complete list: | ||
|
|
||
| * **Top nav** Navigation menu on top of the app (contains Save button) |
There was a problem hiding this comment.
Top nav > Kibana toolbar
For example, https://www.elastic.co/guide/en/kibana/current/dashboard-create-new-dashboard.html#save-dashboards
| Lens has a lot of UI elements – to make it easier to refer to them in issues or bugs, this is a hopefully complete list: | ||
|
|
||
| * **Top nav** Navigation menu on top of the app (contains Save button) | ||
| * **Query bar** Input to enter KQL or Lucene query below the top nav |
There was a problem hiding this comment.
How about:
Input to enter KQL or Lucene queries. Located below the Kibana toolbar.
|
|
||
| * **Top nav** Navigation menu on top of the app (contains Save button) | ||
| * **Query bar** Input to enter KQL or Lucene query below the top nav | ||
| * **Filter bar** Row of filter pills below the query bar |
There was a problem hiding this comment.
How about:
A row of filter options. Located below the query bar.
| * **Top nav** Navigation menu on top of the app (contains Save button) | ||
| * **Query bar** Input to enter KQL or Lucene query below the top nav | ||
| * **Filter bar** Row of filter pills below the query bar | ||
| * **Time picker** Global time range configurator right to the query bar |
There was a problem hiding this comment.
Time picker > Time filter
For example, https://www.elastic.co/guide/en/kibana/current/set-time-filter.html
| * **Query bar** Input to enter KQL or Lucene query below the top nav | ||
| * **Filter bar** Row of filter pills below the query bar | ||
| * **Time picker** Global time range configurator right to the query bar | ||
| * **Data panel** Panel to the left showing the field list |
There was a problem hiding this comment.
I'm weary about using the word panel, since dashboard already uses this term.
I recently changed this in the Visualize docs refresh to simply Data fields.
So maybe this could be:
The data fields that appear depending on the selected index pattern
| * **Config panel** Panel to the right showing configuration of the current chart, separated by layers | ||
| * **Layer panel** One of multiple panels in the config panel, holding configuration for separate layers | ||
| * **Dimension trigger** Chart dimension like "X axis", "Break down by" or "Slice by" in the config panel | ||
| * **Dimension popover** Popover shown when clicking a dimension trigger |
There was a problem hiding this comment.
We typically refer to these as window in the docs.
How about:
Configuration option window Specifies the customization options for each configuration option.
| * **Layer panel** One of multiple panels in the config panel, holding configuration for separate layers | ||
| * **Dimension trigger** Chart dimension like "X axis", "Break down by" or "Slice by" in the config panel | ||
| * **Dimension popover** Popover shown when clicking a dimension trigger | ||
| * **Layer settings popover** Popover shown when clicking the button in the top left of a layer panel |
There was a problem hiding this comment.
The UI says Edit layer settings, so maybe just reuse that?
How about:
Edit layer settings Specifies the available visualization types.
| * **Layer settings popover** Popover shown when clicking the button in the top left of a layer panel | ||
| * **Workspace panel** Center panel containing the chart preview, title and toolbar | ||
| * **Chart preview** Full-sized rendered chart in the center of the screen | ||
| * **Toolbar** Bar on top of the chart preview, containing the chart switcher to the left with chart specific settings right to it |
There was a problem hiding this comment.
Maybe Lens toolbar to differentiate from the Kibana toolbar.
| * **Workspace panel** Center panel containing the chart preview, title and toolbar | ||
| * **Chart preview** Full-sized rendered chart in the center of the screen | ||
| * **Toolbar** Bar on top of the chart preview, containing the chart switcher to the left with chart specific settings right to it | ||
| * **Chart switch** Select to change the chart type in the top left above the chart preview |
There was a problem hiding this comment.
I would call this the Visualization drop down menu
| * **Chart preview** Full-sized rendered chart in the center of the screen | ||
| * **Toolbar** Bar on top of the chart preview, containing the chart switcher to the left with chart specific settings right to it | ||
| * **Chart switch** Select to change the chart type in the top left above the chart preview | ||
| * **Chart settings popover** Popover shown when clicking the "Settings" button above the chart preview |
There was a problem hiding this comment.
I would change this to Visualization Settings
|
Sorry @KOTungseth I merged the master PR too early. Let me quickly merge this one as well to keep |
Backports the following commits to 7.x: