From 77280c29f1ebc3a0de544edd610b7474cf65d900 Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Wed, 10 Mar 2021 18:24:31 +0000 Subject: [PATCH 1/2] add initial rfc to repo --- rfcs/aria-roles.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 rfcs/aria-roles.md diff --git a/rfcs/aria-roles.md b/rfcs/aria-roles.md new file mode 100644 index 000000000000000..2cddb2c9de19574 --- /dev/null +++ b/rfcs/aria-roles.md @@ -0,0 +1,49 @@ +# MDN content project: ARIA roles reference docs + +This RFC proposes that we work on completing the [ARIA role reference docs](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles) +available on MDN. We did quite a bit of work on this in the past, including +having it as a major workstream at a past [Accessibility Hack on MDN event](https://hacks.mozilla.org/2018/10/hack-on-mdn-better-accessibility-for-mdn-web-docs/), +but we still never got around to completing the docs. + +## Problem statement + +ARIA roles are an important part of the [WAI-ARIA](https://w3c.github.io/aria/) +technology standard — they allow us to provide semantics where semantics are +lacking, for the benefit of AT and AT-users. Unfortunately many roles are a bit +obscure in their use, especially across different browser and screenreader +combinations, and a lot of information on this topic is spread far and wide +across the Web. It would be great to provide a deep and complete resource on +this in one place. + +## Priority assessment + +This table checks this project against the [OWD prioritization criteria](https://github.com/openwebdocs/project/blob/main/steering-committee/prioritization-criteria.md). + +| Criteria | Assessment | +| -------------------------------------------- | ----------- | +| Effort | Medium/High: Each page (60) is fairly large and may require some research. | +| Dependencies | Need to find accessibility experts to help. | +| Community enablement | Yes. Each page is a self-contained task. | +| Momentum | Low/Medium. The tech itself is fairly stable, but a11y is something we want to push. | +| Enabling learners | Not really. The MDN Learn section contains ARIA basics already. | +| Enabling professionals | Yes. | +| Underrepresented topics / Ethical web | Yes. We want to push forward the importance of a11y and make it easier to action. | +| Operational necessities | In a way, yes. Without a11y, certain groups cannot use the web. | +| Addressing the needs of the web industry | Accessibility not seen as a major pain point in Web DNA, but is that just because people don't understand it? | + +## Proposed solutions + +We need to write those pages. + +## Task list + +- Write out list of which roles pages are not written yet, and which ones are + incomplete/need improvement. +- Make sure we agree on a template to base each page on — what does each page + need? +- Write an issue for each page, and try to enlist the help of a11y experts to + write recommendations for the use cases/potential examples for each role, + plus links to anything that would help people get started. +- Contact folks in the a11y community who might be willing to help write such + pages. Get them working on pages. +- Create a spreadsheet to track progress on each page. From d7b8b76d5150f48b9a7718bbba3c9d1547041a39 Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Thu, 11 Mar 2021 09:37:00 +0000 Subject: [PATCH 2/2] update table markdown, add rfcs to markdown linting --- .github/workflows/markdown-lint.yml | 1 + rfcs/aria-roles.md | 27 ++++++++++++++++----------- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml index 7a6fde4818309aa..199631b81c68723 100644 --- a/.github/workflows/markdown-lint.yml +++ b/.github/workflows/markdown-lint.yml @@ -6,6 +6,7 @@ on: - main paths: - '*.md' + - 'rfcs/**/*.md' - .github/workflows/markdown-lint.yml diff --git a/rfcs/aria-roles.md b/rfcs/aria-roles.md index 2cddb2c9de19574..cd97e3b2bead1ed 100644 --- a/rfcs/aria-roles.md +++ b/rfcs/aria-roles.md @@ -19,17 +19,22 @@ this in one place. This table checks this project against the [OWD prioritization criteria](https://github.com/openwebdocs/project/blob/main/steering-committee/prioritization-criteria.md). -| Criteria | Assessment | -| -------------------------------------------- | ----------- | -| Effort | Medium/High: Each page (60) is fairly large and may require some research. | -| Dependencies | Need to find accessibility experts to help. | -| Community enablement | Yes. Each page is a self-contained task. | -| Momentum | Low/Medium. The tech itself is fairly stable, but a11y is something we want to push. | -| Enabling learners | Not really. The MDN Learn section contains ARIA basics already. | -| Enabling professionals | Yes. | -| Underrepresented topics / Ethical web | Yes. We want to push forward the importance of a11y and make it easier to action. | -| Operational necessities | In a way, yes. Without a11y, certain groups cannot use the web. | -| Addressing the needs of the web industry | Accessibility not seen as a major pain point in Web DNA, but is that just because people don't understand it? | +* **Effort**: Medium/High: Each page (60) is fairly large and may require some + research. +* **Dependencies**: Need to find accessibility experts to help. +* **Community enablement**: Yes. Each page is a self-contained task. +* **Momentum**: Low/Medium. The tech itself is fairly stable, but a11y is + something we want to push. +* **Enabling learners**: Not really. The MDN Learn section contains ARIA basics + already. +* **Enabling professionals**: Yes. +* **Underrepresented topics / Ethical web**: Yes. We want to push forward the + importance of a11y and make it easier to action. +* **Operational necessities**: In a way, yes. Without a11y, certain groups + cannot use the web. +* **Addressing the needs of the web industry**: Accessibility not seen as a + major pain point in Web DNA, but is that just because people don't understand + it? ## Proposed solutions