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

[ML] Ensure links are distinguished from surrounding text in a way that does not rely on color validation error on Overview page #154294

Closed
bhavyarm opened this issue Apr 3, 2023 · 10 comments · Fixed by #159609
Assignees
Labels
bug Fixes for quality problems that affect the customer experience :ml Project:Accessibility v8.9.0

Comments

@bhavyarm
Copy link
Contributor

bhavyarm commented Apr 3, 2023

Kibana version: main

Browser version: chrome latest

Browser OS version: OS X

Describe the bug: These two links on ML overview page - transforms & entity-centric source data set here is failing the a11y validation rule:

Ensure links are distinguished from surrounding text in a way that does not rely on colour. 

Screen Shot 2023-04-03 at 5 41 21 PM

Screen Shot 2023-04-03 at 5 43 47 PM

@bhavyarm bhavyarm added bug Fixes for quality problems that affect the customer experience Project:Accessibility :ml labels Apr 3, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-accessibility (Project:Accessibility)

@elasticmachine
Copy link
Contributor

Pinging @elastic/ml-ui (:ml)

@bhavyarm
Copy link
Contributor Author

bhavyarm commented Apr 3, 2023

cc @1Copenut thanks

@bhavyarm
Copy link
Contributor Author

bhavyarm commented Apr 4, 2023

cc @elastic/kibana-design this seems like a generic issue. So will need inputs. Thanks :)

@mdefazio
Copy link
Contributor

mdefazio commented Apr 5, 2023

@bhavyarm Here's a few thoughts on this:

  • Entity-centric is a concept under Transforms. Likely that to understand it, the user must first understand transforms. So this seems premature to link to from here
  • Transforms are required for most DF jobs, so we should be pushing them to create one more prominently
  • The docs for Data Frame jobs provides a link to Transforms (in a callout at the top)—I'd recommend letting that do the work rather than duplicate it here
  • So as for A11y issues, I think we can solve these by simply removing these links. Would still be good. to have @1Copenut review the proposed design to make sure. (We do still show links in callouts on the EUI docs pages, perhaps there's followup there too?)

Here's a mockup showing these changes:

  • Adds a title to the callout: This text is long enough it would benefit from having a heading to provide context
  • Swapped out callout text with some of the text from the Transforms doc callout on the data frame job docs page
  • Added a secondary button to the empty prompt directing them to the Transform page within Stack Management. This could make sense as a button within the callout.

cc/ @szabosteve for some extra copy help—I tried condensing the Transform callout from the docs, but would be good to get your eyes on it. Thank you!

image

@peteharverson peteharverson changed the title Ensure links are distinguished from surrounding text in a way that does not rely on color validation error on ml overview page [ML] Ensure links are distinguished from surrounding text in a way that does not rely on color validation error on Overview page Apr 6, 2023
@szabosteve
Copy link
Contributor

Hi @mdefazio, 👋

I would suggest only some minor changes in the transform callout text.

Title of the callout: 
Transform your data into a data frame

Description: 
Data frame analytics requires specifically structured source data; a two-dimensional tabular data structure. 
Use transforms to convert your data into a data frame.

WDYT?

(A side note: The transforms app contains a link to the transforms documentation, so I agree that linking to the transforms docs here in the empty state is not necessary.)

@mdefazio
Copy link
Contributor

mdefazio commented Apr 6, 2023

Works for me! Thanks for taking a look.

@1Copenut
Copy link
Contributor

1Copenut commented Apr 6, 2023

Linking related (wider) issue: #154570

@1Copenut
Copy link
Contributor

1Copenut commented Apr 6, 2023

@mdefazio Removing the accent links from the block of text meets the ask to my thinking. I think this solution works, with a caveat that we may end up revisiting it if so requested.

Links that stand away from other elements (low to no proximity) are easier to justify without underlines or icons, because their deliberate offset / placement gives them a subtle suggestion of action.

@peteharverson
Copy link
Contributor

Moving to 8.9.0, where we plan to address this issue as part of wider changes planned for the Overview page.

darnautov added a commit that referenced this issue Jun 20, 2023
## Summary

Resolves #154294 and updates the
UI of the Overview page

- Updates panels layout 
- Stores expand/collapsed state of the panels in the local storage 
- Update empty states text and layout 

<img width="1341" alt="image"
src="https://github.com/elastic/kibana/assets/5236598/8833fa2a-b574-44ee-bacb-e974186dd35f">


### Checklist

- [ ] 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
- [x] [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
- [x] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [x] 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))
- [x] 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))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)
darnautov added a commit to darnautov/kibana that referenced this issue Jun 20, 2023
## Summary

Resolves elastic#154294 and updates the
UI of the Overview page

- Updates panels layout
- Stores expand/collapsed state of the panels in the local storage
- Update empty states text and layout

<img width="1341" alt="image"
src="https://github.com/elastic/kibana/assets/5236598/8833fa2a-b574-44ee-bacb-e974186dd35f">

### Checklist

- [ ] 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
- [x] [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
- [x] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [x] 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))
- [x] 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))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

(cherry picked from commit 6ac52fb)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience :ml Project:Accessibility v8.9.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants