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

Docs: Add accessbility specific page #13169

Merged
merged 2 commits into from
Jan 30, 2019
Merged

Docs: Add accessbility specific page #13169

merged 2 commits into from
Jan 30, 2019

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Jan 2, 2019

Description

Adds an additional page to the developer handbook on accessibility
in particular the landmark regions.

Fixes #3217

Types of changes

Documentation

@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Jan 2, 2019
@mkaz mkaz requested a review from afercia January 4, 2019 17:53
@gziolo gziolo added the Needs Accessibility Feedback Need input from accessibility label Jan 25, 2019
@gziolo
Copy link
Member

gziolo commented Jan 25, 2019

It looks like landmark regions used in Gutenberg and listed in #3217 aren't documented. @afercia how does it look as of today? What should be added to this document?

@afercia
Copy link
Contributor

afercia commented Jan 25, 2019

@gziolo I see there is a Landmark Regions section, even though it doesn't mention the navigateRegions component? That one is documented in packages/components/src/higher-order/navigate-regions/README.md but maybe it should be made clearer what is the purpose of landmark regions and that they use navigateRegions.

The most important thing is to clarify to devs that any content must live within a landmark region. I guess in 99% of the cases this is handled automatically.

@gziolo gziolo added this to the Documentation & Handbook milestone Jan 28, 2019
@gziolo
Copy link
Member

gziolo commented Jan 28, 2019

@mkaz do you plan to add some more details to the PR as suggested by @afercia, by the way thanks for sharing your feedback.

mkaz added 2 commits January 29, 2019 10:49
Adds an additional page to the developer handbook on accessibility
in particular the landmark regions.

Fixes #3217
@mkaz mkaz force-pushed the docs/accessibility branch from d40642b to aed9289 Compare January 29, 2019 18:55
@mkaz
Copy link
Member Author

mkaz commented Jan 29, 2019

@gziolo @afercia I updated and added a link out to the navigateRegions package.
Let me know anything else you would like to add to this page and we can.

Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a good start. I'm sure we will find more content to add to this page in the future :)

@gziolo gziolo merged commit e5e6d6c into master Jan 30, 2019
@gziolo gziolo deleted the docs/accessibility branch January 30, 2019 07:49
@gziolo
Copy link
Member

gziolo commented Jan 30, 2019

Thank you @mkaz for taking the initiative and props to @afercia for your great feedback.

@gziolo gziolo removed the Needs Accessibility Feedback Need input from accessibility label Jan 30, 2019
daniloercoli added a commit that referenced this pull request Jan 30, 2019
…rnmobile/372-use-RichText-on-Title-block

* 'master' of https://github.com/WordPress/gutenberg: (36 commits)
  Fixes plural messages POT generation. (#13577)
  Typo fix (#13595)
  REST API: Remove oEmbed proxy HTML filtering (#13575)
  Removed unnecessary className attribute. Fixes #11664 (#11831)
  Add changelog for RSS block (#13588)
  Components: Set type=button for TabPanel button elements. (#11944)
  Update util.js (#13582)
  Docs: Add accessbility specific page (#13169)
  Rnmobile/media methods refactor (#13554)
  chore(release): publish
  chore(release): publish
  Plugin: Deprecate gutenberg_get_script_polyfill (#13536)
  Block API: Parse entity only when valid character reference (#13512)
  RichText: List: fix indentation (#13563)
  Plugin: Deprecate window._wpLoadGutenbergEditor (#13547)
  Plugin: Avoid setting generic "Edit Post" title on load (#13552)
  Plugin: Populate demo content by default content filters (#13553)
  RichText: List: Fix getParentIndex (#13562)
  RichText: List: Fix outdent with children (#13559)
  Scripts: Remove npm run build from test-e2e default run (#13420)
  ...
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Docs: Add accessbility specific page

Adds an additional page to the developer handbook on accessibility
in particular the landmark regions.

Fixes #3217

* Add navigationRegions link
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Docs: Add accessbility specific page

Adds an additional page to the developer handbook on accessibility
in particular the landmark regions.

Fixes #3217

* Add navigationRegions link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants