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

[Dashboard Usability] Improve "Edit panel settings" in the panel menu #160256

Closed
teresaalvarezsoler opened this issue Jun 22, 2023 · 14 comments · Fixed by #161399
Closed

[Dashboard Usability] Improve "Edit panel settings" in the panel menu #160256

teresaalvarezsoler opened this issue Jun 22, 2023 · 14 comments · Fixed by #161399
Assignees
Labels
enhancement New value added to drive a business result Feature:Dashboard Dashboard related features impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas

Comments

@teresaalvarezsoler
Copy link

Problems

  1. The pencil icon is already used for editing the visualization which is confusing.
    image

  2. The icon used in the listing pages to view details is not the pencil: image

  3. The wording "Edit" is a bit confusing because users can't edit much in view mode. It also makes this option wording too long.
    image

Solution

  1. Replace the pencil icon (see discussion below)
  2. Replace Edit panel settings by Panel settings
@teresaalvarezsoler teresaalvarezsoler added Feature:Dashboard Dashboard related features enhancement New value added to drive a business result Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas loe:small Small Level of Effort impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. labels Jun 22, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@teresaalvarezsoler
Copy link
Author

The icon used in the page list to view the details is already in use by the "Inspect" option, should we change that option icon and use the inspect one for the panel settings? @andreadelrio
image

@Heenawter
Copy link
Contributor

Heenawter commented Jun 22, 2023

I'm not sure that Inspect is the right word for view mode, considering the fact that custom time ranges and, eventually, panel-level filters/queries will be editable in this flyout (even in view mode) as discussed here. Using "Inspect", at least to me, suggests that you are simply viewing details about the panel, and it does not let the user know that there are pieces of editable state in the flyout.

We could go the Controls route and simply have a general "Settings" option, without the word "Edit"?

image

@teresaalvarezsoler
Copy link
Author

I like the idea @Heenawter . Could we also change the icon and wording in the listing view of visualizations and dashboards to be consistent?

@teresaalvarezsoler
Copy link
Author

Change the gear by the three dots in Edit mode for the panel settings menu

stratoula added a commit that referenced this issue Jul 11, 2023
## Summary

Part of #160256

- Replaces the Edit panel settings text with the simpler Panel settings
- Replaces the documentation
- Replaces the icon

<img width="1757" alt="image"
src="https://github.com/elastic/kibana/assets/17003240/e0ea6c19-8a65-44b8-906e-c364c00536a0">

### Checklist

- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
@cqliu1 cqliu1 self-assigned this Jul 17, 2023
@cqliu1
Copy link
Contributor

cqliu1 commented Jul 17, 2023

With #161616 merged, the Edit panel settings label now says just Panel settings and uses the gear icon instead of the pencil icon.

Screenshot 2023-07-17 at 2 06 40 PM

To clarify the remaining To-Do's for this issue:

Change the gear by the three dots in Edit mode for the panel settings menu

@teresaalvarezsoler Are you talking about the gear button in the top right corner of the panel and using the horizontal 3 dots icon like in view mode?

Edit mode

Screenshot 2023-07-17 at 2 12 37 PM

View mode

Screenshot 2023-07-17 at 2 25 32 PM

Could we also change the icon and wording in the listing view of visualizations and dashboards to be consistent?

Screenshot 2023-07-17 at 2 17 43 PM Screenshot 2023-07-17 at 2 17 48 PM

Currently the two actions are Edit with a pencil icon which opens the selected vis in its respective editor or dashboard in edit mode and View details with an inspect icon, which opens a flyout to edit the title, description, and tags of the selected vis/dashboard without leaving the listing page. Is this Edit action necessary, or can we remove it since you clicking on the title already opens the vis/dashboard? Should we change View details to Settings and use a gear icon instead? @andreadelrio Do you have any thoughts on how to make these actions more clear?

@teresaalvarezsoler
Copy link
Author

Are you talking about the gear button in the top right corner of the panel and using the horizontal 3 dots icon like in view mode?

Exactly :)

@teresaalvarezsoler
Copy link
Author

Is this Edit action necessary, or can we remove it since you clicking on the title already opens the vis/dashboard?

Good question... I do't have a strong opinion on this. I would leave just to be consistent with the Visualize Library UX.
image

Should we change View details to Settings and use a gear icon instead?

Yes, I think that works much better. But maybe we should also change it in the Visualize Library to be consistent.
@andreadelrio any thoughts?

@nreese
Copy link
Contributor

nreese commented Jul 18, 2023

Is this Edit action necessary, or can we remove it since you clicking on the title already opens the vis/dashboard?

Clicking title opens dashboard in view mode. Clicking the edit action opens dashboard in edit mode. Not for or against removing edit icon but there is a difference between the two

@teresaalvarezsoler
Copy link
Author

Good point, let's keep it then

@Heenawter
Copy link
Contributor

Heenawter commented Jul 18, 2023

Clicking title opens dashboard in view mode.

Note: The title only opens the dashboard in view mode if it wasn't last opened in edit mode; otherwise, if the dashboard was last opened in edit mode, clicking the title will also open the dashboard in edit mode. This is kind of confusing behaviour IMO. The pencil icon does indeed always open the dashboard in edit mode.

Also, if we go the route of storing the view mode in local storage as described in this issue, I wonder if this distinction becomes less important? 🤔 With this change, I think that having a different "view" and "edit" path via the listing page adds confusion, since this would no longer be a "per dashboard" piece of state and would instead be stored as part of the "dashboard app" state

@andreadelrio
Copy link
Contributor

@teresaalvarezsoler +1 to consistency with the Visualization listing page. However, I feel like the inspect icon is confusing. Truth is, we use it to represent different meanings across Kibana (including Preview, View details and, Inspect). I reviewed this with @cqliu1. We think we can use the iInCircle icon instead. As a reference, you can find a similar use case in Google Drive. We discussed using the gear icon but that could be confusing because this flyout doesn't show all the dashboard settings that are available to the user once they're inside a dashboard.

Screenshot 2022-12-12 at 13 27 03

image

@teresaalvarezsoler
Copy link
Author

Thanks @andreadelrio and @cqliu1 . Totally agree with using theiInCircle :) can we also change it in the Visualization Library?

@cqliu1
Copy link
Contributor

cqliu1 commented Jul 20, 2023

Totally agree with using theiInCircle :) can we also change it in the Visualization Library?

Absolutely! All of the changes I'm making will carry over to the visualize library listing page as well.

cqliu1 added a commit that referenced this issue Aug 7, 2023
…shboard listing page (#161399)

## Summary

Closes #144481.
Closes #160256.

This enables content editor in dashboard to allow users to edit the
title, description, and tags from the listing page.


https://github.com/elastic/kibana/assets/1697105/c2212882-43e3-45cb-83fc-493860857019

The only validation added to this flyout is the duplicate title check. I
used the same warning message as the visualize listing page.

<img width="600" alt="Screenshot 2023-07-06 at 2 11 38 PM"
src="https://github.com/elastic/kibana/assets/1697105/42f7244a-1c4d-47ec-8f66-a98a63eff473">

### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
crespocarlos pushed a commit to crespocarlos/kibana that referenced this issue Aug 8, 2023
…shboard listing page (elastic#161399)

## Summary

Closes elastic#144481.
Closes elastic#160256.

This enables content editor in dashboard to allow users to edit the
title, description, and tags from the listing page.


https://github.com/elastic/kibana/assets/1697105/c2212882-43e3-45cb-83fc-493860857019

The only validation added to this flyout is the duplicate title check. I
used the same warning message as the visualize listing page.

<img width="600" alt="Screenshot 2023-07-06 at 2 11 38 PM"
src="https://github.com/elastic/kibana/assets/1697105/42f7244a-1c4d-47ec-8f66-a98a63eff473">

### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
bryce-b pushed a commit to bryce-b/kibana that referenced this issue Aug 9, 2023
…shboard listing page (elastic#161399)

## Summary

Closes elastic#144481.
Closes elastic#160256.

This enables content editor in dashboard to allow users to edit the
title, description, and tags from the listing page.


https://github.com/elastic/kibana/assets/1697105/c2212882-43e3-45cb-83fc-493860857019

The only validation added to this flyout is the duplicate title check. I
used the same warning message as the visualize listing page.

<img width="600" alt="Screenshot 2023-07-06 at 2 11 38 PM"
src="https://github.com/elastic/kibana/assets/1697105/42f7244a-1c4d-47ec-8f66-a98a63eff473">

### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Dashboard Dashboard related features impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas
Projects
None yet
6 participants