Skip to content

Remove Kibana a11y guide in favor of EUI#52478

Closed
timroes wants to merge 1 commit intoelastic:masterfrom
timroes:a11y-styleguide
Closed

Remove Kibana a11y guide in favor of EUI#52478
timroes wants to merge 1 commit intoelastic:masterfrom
timroes:a11y-styleguide

Conversation

@timroes
Copy link
Copy Markdown
Contributor

@timroes timroes commented Dec 9, 2019

Summary

Removing the Kibana a11y style guide in favor of the new, way cooler EUI a11y styleguide.

@timroes timroes added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.6.0 labels Dec 9, 2019
@timroes timroes requested a review from myasonik December 9, 2019 08:21
@timroes timroes changed the title Remove Kibana a11y guide in favor of EUI [skip ci] Remove Kibana a11y guide in favor of EUI Dec 9, 2019
@myasonik
Copy link
Copy Markdown
Contributor

myasonik commented Dec 9, 2019

Not sure if I'm in favor of this...

I just updated the Kibana guide to do a few things:

  • right at the top it points to EUI's guide
  • then it talks about running the a11y tests which isn't covered in the EUI guide because it's Kibana specific (you could say this is redundant because I also talk about the a11y tests wherever we talk about functional tests but it's usually good to have docs wherever people will go looking for them imo)
  • then it talks about ID generation (again, not sure if this is worthwhile for people or not but, again, it is Kibana specific)

@timroes
Copy link
Copy Markdown
Contributor Author

timroes commented Dec 9, 2019

Good points. I am still worried the more developers need to read, the less likely any of it will be read :D

What would you think about moving the a11y testing guide into the development guide in the repository (beside the other testing paragraphs), and the HTML generation into the top level STYLEGUIDE.md file, since it shouldn't clutter it to much, and then instead link into the EUI styleguide? Or do you feel we'd still be losing to much in that case?

@myasonik
Copy link
Copy Markdown
Contributor

myasonik commented Dec 9, 2019

Sure, sounds like a good plan. I'm happy to consolidate our files.

If you don't want to touch so much, I'm happy to take this as a to-do myself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release_note:skip Skip the PR/issue when compiling release notes v7.6.0 v8.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants