From 249997a412003afc28684edbdd5e116a20831fe1 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Thu, 3 Nov 2016 23:02:34 +0100 Subject: [PATCH 1/8] A11Y Mandate --- proposed/a11y-mandate.md | 54 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 proposed/a11y-mandate.md diff --git a/proposed/a11y-mandate.md b/proposed/a11y-mandate.md new file mode 100644 index 0000000..d72a843 --- /dev/null +++ b/proposed/a11y-mandate.md @@ -0,0 +1,54 @@ +_Note: This recommendation is a DRAFT for consideration of the MODX Governance Advisory Board._ + + +To ensure that the MODX Next core is developed in accordance with globally adopted accessibility guidelines all new or updated code released with the MODX Next core must conform with the WCAG 2.0 guidelines at level AA in addition to any guidelines accepted by the MODX Advisory Board. + + +**Editor: JP de Vries** +**First publish draft: Nov 3, 2016** + + +## Goal of Recommendation + + +To provide all MODX users the ability to author and publish the web. + + +## Relevant Recommendations + - [DRAFT] Core Goals + + +## Relevant Material +[Themes Not Websites](https://www.joedolson.com/2016/08/themes-not-web-sites/) – some excellent points on why WCAG applies to site content, and not necessarily manager themes +[Drupal 8 Accessibility Features](https://twitter.com/johan_ramon/status/773150640403058689) + + +## Recommendation +MODX enables site builders to not only create amazing experiences but also the creative freedom necessary to ensure the sites they create are accessible to all users. Unfortunately, to date the site building experience itself is not accessible to all users. MODX Next allows for breaking changes and with this opportunity we can adopt guidelines to ensure anything released with the MODX Next core is truly accessible. + + +> “Accessibility is a blueberry muffin. You can’t push the blueberries in afterwards.” – Cordelia McGee-Tubb + + +It is imperative that accessibility be considered first and foremost in the design and development process. This isn’t just to ensure that the end product is accessible to underrepresented groups but perhaps more importantly that it is user friendly and a better experience for everyone. + + +> “Accessibility is a fundamental design problem, not a liability problem” – David Storey + + +While MODX has acknowledged the importance of accessibility, to date the project hasn’t been able to accurately define accessibility – let alone a path towards it. It would be unrealistic to expect MODX Contributors to become accessibility experts capable of following WCAG 2.0 Level AA and other best practices over night. This is why supporting documentation, examples, and human resources will be needed to make accessibility best practices accessible to contributors. Pun intended. + + +Core Contributors will be encouraged to consult and collaborate with Accessibility Inspectors within the MODX Community so that they are not surprised if a pull request is rejected due to lack of compliance with WCAG Guidelines or additional guidelines adopted by the governance board. + + +We must not allow our quest for accessible code to result in making the process of authoring an approved Pull Request become less accessible to developers. In other words, a novice to accessibility should feel as comfortable proposing recommendations and Pull Requests as an expert. If a contributor is unable to seek out or afford accessibility consultation an Accessibility Inspectors will be appointed to them by the _________ in the form of _________________. + + +The WCAG Guidelines clearly defines requirements, but who decides if a Pull Request conforms to these guidelines? When architecting a structural building an architect designs the building, a builder constructs the building, and an inspector inspects the building to ensure it satisfies the appropriate building codes. The architect and the builder are expected to have knowledge of and follow building codes, but in the end it is the inspector who is the judge of if the building is structurally sound. + + +Front End Pull Requests must be approved by a certified MODX Accessibility Inspector who may not also be the author of the Pull Request being inspected. Back End Pull Requests that may impact accessibility on the front end shall also be inspected. For example, assuming the Synchronous Endpoints recommendation is accepted, interactions with the database such as accepting and processing user input must be supported both asynchronously and synchronously. + + +_NOTE: How are Accessibility Inspectors approved? By the board? By an appointed Accessibility Ambassador? By a community committee?_ From 6ce311af89638ddfcb9f4d9c8d272441b50b2dc5 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Fri, 21 Apr 2017 13:54:46 +0200 Subject: [PATCH 2/8] removing references to WCAG WCAG is dropping the W and becoming CAG as 2.1 will apply to more than just "web" (apps) and then 3.0 will have another name entirely, currently codenamed "Silver" --- proposed/a11y-mandate.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/proposed/a11y-mandate.md b/proposed/a11y-mandate.md index d72a843..8914bee 100644 --- a/proposed/a11y-mandate.md +++ b/proposed/a11y-mandate.md @@ -1,7 +1,7 @@ _Note: This recommendation is a DRAFT for consideration of the MODX Governance Advisory Board._ -To ensure that the MODX Next core is developed in accordance with globally adopted accessibility guidelines all new or updated code released with the MODX Next core must conform with the WCAG 2.0 guidelines at level AA in addition to any guidelines accepted by the MODX Advisory Board. +To ensure that the MODX Next core is developed in accordance with globally adopted accessibility guidelines all new or updated code released with the MODX Next core must conform with the latest accessibility guidelines in addition to any guidelines accepted by the MODX Advisory Board. **Editor: JP de Vries** @@ -36,19 +36,21 @@ It is imperative that accessibility be considered first and foremost in the desi > “Accessibility is a fundamental design problem, not a liability problem” – David Storey -While MODX has acknowledged the importance of accessibility, to date the project hasn’t been able to accurately define accessibility – let alone a path towards it. It would be unrealistic to expect MODX Contributors to become accessibility experts capable of following WCAG 2.0 Level AA and other best practices over night. This is why supporting documentation, examples, and human resources will be needed to make accessibility best practices accessible to contributors. Pun intended. +While MODX has acknowledged the importance of accessibility, to date the project hasn’t been able to accurately define accessibility – let alone a path towards it. It would be unrealistic to expect MODX Contributors to become accessibility experts capable of following the latest accessibility success criteria and other best practices over night. This is why supporting documentation, examples, and human resources will be needed to make accessibility best practices accessible to contributors. Pun intended. -Core Contributors will be encouraged to consult and collaborate with Accessibility Inspectors within the MODX Community so that they are not surprised if a pull request is rejected due to lack of compliance with WCAG Guidelines or additional guidelines adopted by the governance board. +Core Contributors will be encouraged to consult and collaborate with Accessibility Inspectors within the MODX Community so that they are not surprised if a pull request is rejected due to lack of compliance with accessibility guidelines or additional guidelines adopted by the governance board. We must not allow our quest for accessible code to result in making the process of authoring an approved Pull Request become less accessible to developers. In other words, a novice to accessibility should feel as comfortable proposing recommendations and Pull Requests as an expert. If a contributor is unable to seek out or afford accessibility consultation an Accessibility Inspectors will be appointed to them by the _________ in the form of _________________. -The WCAG Guidelines clearly defines requirements, but who decides if a Pull Request conforms to these guidelines? When architecting a structural building an architect designs the building, a builder constructs the building, and an inspector inspects the building to ensure it satisfies the appropriate building codes. The architect and the builder are expected to have knowledge of and follow building codes, but in the end it is the inspector who is the judge of if the building is structurally sound. +Accessibility guidelines clearly defines requirements, but who decides if a Pull Request conforms to these guidelines? When architecting a structural building an architect designs the building, a builder constructs the building, and an inspector inspects the building to ensure it satisfies the appropriate building codes. The architect and the builder are expected to have knowledge of and follow building codes, but in the end it is the inspector who is the judge of if the building is structurally sound. -Front End Pull Requests must be approved by a certified MODX Accessibility Inspector who may not also be the author of the Pull Request being inspected. Back End Pull Requests that may impact accessibility on the front end shall also be inspected. For example, assuming the Synchronous Endpoints recommendation is accepted, interactions with the database such as accepting and processing user input must be supported both asynchronously and synchronously. +Front End Pull Requests must be approved by a certified MODX Accessibility Advisors who may not also be the author of the Pull Request being inspected. Back End Pull Requests that may impact accessibility on the front end shall also be inspected. For example, assuming the Synchronous Endpoints recommendation is accepted, interactions with the database such as accepting and processing user input must be supported both asynchronously and synchronously. + +While inspection at the end of the development process is needed, ideally accessibility review should be integrated into the forefront of the process. Accessibility Advisors should be available to collaborate with the community and development teams at any point in the development process. _NOTE: How are Accessibility Inspectors approved? By the board? By an appointed Accessibility Ambassador? By a community committee?_ From eb85102e63fe1d5ba484e5670f727d1816438117 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Fri, 21 Apr 2017 13:55:35 +0200 Subject: [PATCH 3/8] Accessibility Inspector -> Accessibility Advisor --- proposed/a11y-mandate.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/proposed/a11y-mandate.md b/proposed/a11y-mandate.md index 8914bee..b9670f0 100644 --- a/proposed/a11y-mandate.md +++ b/proposed/a11y-mandate.md @@ -39,10 +39,10 @@ It is imperative that accessibility be considered first and foremost in the desi While MODX has acknowledged the importance of accessibility, to date the project hasn’t been able to accurately define accessibility – let alone a path towards it. It would be unrealistic to expect MODX Contributors to become accessibility experts capable of following the latest accessibility success criteria and other best practices over night. This is why supporting documentation, examples, and human resources will be needed to make accessibility best practices accessible to contributors. Pun intended. -Core Contributors will be encouraged to consult and collaborate with Accessibility Inspectors within the MODX Community so that they are not surprised if a pull request is rejected due to lack of compliance with accessibility guidelines or additional guidelines adopted by the governance board. +Core Contributors will be encouraged to consult and collaborate with Accessibility Advisor within the MODX Community so that they are not surprised if a pull request is rejected due to lack of compliance with accessibility guidelines or additional guidelines adopted by the governance board. -We must not allow our quest for accessible code to result in making the process of authoring an approved Pull Request become less accessible to developers. In other words, a novice to accessibility should feel as comfortable proposing recommendations and Pull Requests as an expert. If a contributor is unable to seek out or afford accessibility consultation an Accessibility Inspectors will be appointed to them by the _________ in the form of _________________. +We must not allow our quest for accessible code to result in making the process of authoring an approved Pull Request become less accessible to developers. In other words, a novice to accessibility should feel as comfortable proposing recommendations and Pull Requests as an expert. If a contributor is unable to seek out or afford accessibility consultation an Accessibility Advisor will be appointed to them by the _________ in the form of _________________. Accessibility guidelines clearly defines requirements, but who decides if a Pull Request conforms to these guidelines? When architecting a structural building an architect designs the building, a builder constructs the building, and an inspector inspects the building to ensure it satisfies the appropriate building codes. The architect and the builder are expected to have knowledge of and follow building codes, but in the end it is the inspector who is the judge of if the building is structurally sound. @@ -53,4 +53,4 @@ Front End Pull Requests must be approved by a certified MODX Accessibility Advis While inspection at the end of the development process is needed, ideally accessibility review should be integrated into the forefront of the process. Accessibility Advisors should be available to collaborate with the community and development teams at any point in the development process. -_NOTE: How are Accessibility Inspectors approved? By the board? By an appointed Accessibility Ambassador? By a community committee?_ +_NOTE: How are Accessibility Advisors approved? By the board? By an appointed Accessibility Ambassador? By a community committee?_ From 9f5cf1f135d4bd7e7a4acfd822a929205fc08b68 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Fri, 23 Jun 2017 17:17:54 +0200 Subject: [PATCH 4/8] removing reference to MODX next --- proposed/a11y-mandate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposed/a11y-mandate.md b/proposed/a11y-mandate.md index b9670f0..57203b4 100644 --- a/proposed/a11y-mandate.md +++ b/proposed/a11y-mandate.md @@ -1,7 +1,7 @@ _Note: This recommendation is a DRAFT for consideration of the MODX Governance Advisory Board._ -To ensure that the MODX Next core is developed in accordance with globally adopted accessibility guidelines all new or updated code released with the MODX Next core must conform with the latest accessibility guidelines in addition to any guidelines accepted by the MODX Advisory Board. +To ensure that the MODX core is developed in accordance with globally adopted accessibility guidelines all new or updated code released with the MODX core must conform with the latest accessibility guidelines in addition to any guidelines accepted by the MODX Advisory Board. **Editor: JP de Vries** From c64ebce120bd2ee05dd2f0d96d10b69d2253da37 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Sat, 1 Jul 2017 16:27:39 +0200 Subject: [PATCH 5/8] Update a11y-mandate.md --- proposed/a11y-mandate.md | 55 ++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 19 deletions(-) diff --git a/proposed/a11y-mandate.md b/proposed/a11y-mandate.md index 57203b4..e277746 100644 --- a/proposed/a11y-mandate.md +++ b/proposed/a11y-mandate.md @@ -13,44 +13,61 @@ To ensure that the MODX core is developed in accordance with globally adopted ac To provide all MODX users the ability to author and publish the web. + > “Following these guidelines will make content accessible to a wider range of people with disabilities, including blindness and low vision, deafness and hearing loss, learning disabilities, cognitive limitations, limited movement, speech disabilities, photosensitivity and combinations of these.” + — [WCAG](https://www.w3.org/TR/WCAG20/) ## Relevant Recommendations - - [DRAFT] Core Goals - + - [Accessibile Setup DRAFT](https://github.com/modxcms/mab-recommendations/pull/14) + - [Sync Endpoints DRAFT](https://github.com/modxcms/mab-recommendations/pull/14) + - [Semantic Icons DRAFT](https://github.com/modxcms/mab-recommendations/pull/1) ## Relevant Material -[Themes Not Websites](https://www.joedolson.com/2016/08/themes-not-web-sites/) – some excellent points on why WCAG applies to site content, and not necessarily manager themes -[Drupal 8 Accessibility Features](https://twitter.com/johan_ramon/status/773150640403058689) - + - [Themes Not Websites](https://www.joedolson.com/2016/08/themes-not-web-sites/) – some excellent points on why WCAG applies to site content, and not necessarily manager themes + - [Drupal 8 Accessibility Features](https://twitter.com/johan_ramon/status/773150640403058689) + + ## Recommended Resources + - [Accessibiilty Checklist](http://accessibility.voxmedia.com) + + ## Testing Software + + There is a vast array of accessibility testing software. To get you started, we recommend: + + - [axe-core Browser Extension](https://www.deque.com/products/axe-core/#aXeExtensions) + + ## Support Channels + + - [`#a11y` MODX Community Slack Channel](https://modxcommunity.slack.com/a11y) + - [Accessibility on the MODX Forums](https://forums.modx.com/board/281/sig-accessibility) ## Recommendation -MODX enables site builders to not only create amazing experiences but also the creative freedom necessary to ensure the sites they create are accessible to all users. Unfortunately, to date the site building experience itself is not accessible to all users. MODX Next allows for breaking changes and with this opportunity we can adopt guidelines to ensure anything released with the MODX Next core is truly accessible. - +MODX enables site builders to not only create amazing experiences but also the creative freedom necessary to ensure the sites they create are accessible to all users. Unfortunately, to date the experience of building with MODX is not accessible to all users. Breaking changes allow the opportunity to adopt guidelines and ensure future major versions are truly accessible. -> “Accessibility is a blueberry muffin. You can’t push the blueberries in afterwards.” – Cordelia McGee-Tubb +[Accessibility is water](https://modx.today/posts/2016/02/accessibility-is-water); we are all equally deservant of it. With breaking changes following this recommendation, we'll irrigate accessibility entirely througout our diverse and global community. -It is imperative that accessibility be considered first and foremost in the design and development process. This isn’t just to ensure that the end product is accessible to underrepresented groups but perhaps more importantly that it is user friendly and a better experience for everyone. - +> “Accessibility is a blueberry muffin. You can’t push the blueberries in afterwards.” + — Cordelia McGee-Tubb -> “Accessibility is a fundamental design problem, not a liability problem” – David Storey +It is imperative that accessibility be considered first and foremost in the design and development process. This isn’t just to ensure that the end product is accessible to underrepresented groups but perhaps more importantly that it is user friendly and a better experience for everyone. -While MODX has acknowledged the importance of accessibility, to date the project hasn’t been able to accurately define accessibility – let alone a path towards it. It would be unrealistic to expect MODX Contributors to become accessibility experts capable of following the latest accessibility success criteria and other best practices over night. This is why supporting documentation, examples, and human resources will be needed to make accessibility best practices accessible to contributors. Pun intended. - +While MODX has acknowledged the importance of accessibility, to date the project hasn’t been able to define alone a path towards an accessible product. It would be unrealistic to expect MODX Contributors to become accessibility experts capable of following the latest accessibility success criteria and other best practices over night. This is why supporting documentation, examples, and human resources will be needed to make accessibility best practices accessible to contributors. Pun intended. -Core Contributors will be encouraged to consult and collaborate with Accessibility Advisor within the MODX Community so that they are not surprised if a pull request is rejected due to lack of compliance with accessibility guidelines or additional guidelines adopted by the governance board. +> “Accessibility allows us to tap into everyone’s potential.” + — [@DebraRuh](https://twitter.com/akwyz/status/880712070496387072) +Members appointed by the MODX Advisory Board to an Accessibility Advisory Working Group act as Accessibility Advisors to the greater MODX Community. Core Contributors will be encouraged to consult and collaborate with Accessibility Advisors within the MODX Community so that they are not surprised if a pull request is rejected due to lack of compliance with accessibility guidelines or additional guidelines adopted by the governance board. We must not allow our quest for accessible code to result in making the process of authoring an approved Pull Request become less accessible to developers. In other words, a novice to accessibility should feel as comfortable proposing recommendations and Pull Requests as an expert. If a contributor is unable to seek out or afford accessibility consultation an Accessibility Advisor will be appointed to them by the _________ in the form of _________________. +Accessibility guidelines clearly define requirements, but who decides if a Pull Request conforms to these guidelines? When architecting a structural building an architect designs the building, a builder constructs the building, and an inspector inspects the building to ensure it satisfies the appropriate building codes. The architect and the builder are expected to have knowledge of and follow building codes, but in the end it is the inspector who is the judge of if the building is structurally sound. -Accessibility guidelines clearly defines requirements, but who decides if a Pull Request conforms to these guidelines? When architecting a structural building an architect designs the building, a builder constructs the building, and an inspector inspects the building to ensure it satisfies the appropriate building codes. The architect and the builder are expected to have knowledge of and follow building codes, but in the end it is the inspector who is the judge of if the building is structurally sound. - +> “The best time to think about accessibility is in the beginning, the second best time is now.” + — [@aaroni](https://twitter.com/aaroni/status/880132320220639232) Front End Pull Requests must be approved by a certified MODX Accessibility Advisors who may not also be the author of the Pull Request being inspected. Back End Pull Requests that may impact accessibility on the front end shall also be inspected. For example, assuming the Synchronous Endpoints recommendation is accepted, interactions with the database such as accepting and processing user input must be supported both asynchronously and synchronously. -While inspection at the end of the development process is needed, ideally accessibility review should be integrated into the forefront of the process. Accessibility Advisors should be available to collaborate with the community and development teams at any point in the development process. - +> “Every line of code written without #a11y in mind is a line that must be rewritten later. Pushing #accessibility down the road incurs development debt, increasing dev time and cost.” + — [@mor10](https://twitter.com/mor10/status/879435792686264320) -_NOTE: How are Accessibility Advisors approved? By the board? By an appointed Accessibility Ambassador? By a community committee?_ +While inspection at the end of the development process is needed, ideally accessibility review should be integrated into the forefront of the process. Accessibility Advisors should be available through support channels to collaborate with the community and development teams at any point in the development process. From 84b6305d0e0b1d0a9fc3e618f5a6b322ac345dc9 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Sat, 1 Jul 2017 16:30:18 +0200 Subject: [PATCH 6/8] Update a11y-mandate.md --- proposed/a11y-mandate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposed/a11y-mandate.md b/proposed/a11y-mandate.md index e277746..2230e90 100644 --- a/proposed/a11y-mandate.md +++ b/proposed/a11y-mandate.md @@ -56,7 +56,7 @@ While MODX has acknowledged the importance of accessibility, to date the project > “Accessibility allows us to tap into everyone’s potential.”  — [@DebraRuh](https://twitter.com/akwyz/status/880712070496387072) -Members appointed by the MODX Advisory Board to an Accessibility Advisory Working Group act as Accessibility Advisors to the greater MODX Community. Core Contributors will be encouraged to consult and collaborate with Accessibility Advisors within the MODX Community so that they are not surprised if a pull request is rejected due to lack of compliance with accessibility guidelines or additional guidelines adopted by the governance board. +Members appointed by the MODX Advisory Board to an Accessibility Advisory Working Group act as Accessibility Advisors to the greater MODX Community. Core Contributors will be encouraged to consult and collaborate with Accessibility Advisors so that they are not surprised if a pull request is rejected due to lack of compliance with accessibility guidelines or additional guidelines adopted by the governance board. We must not allow our quest for accessible code to result in making the process of authoring an approved Pull Request become less accessible to developers. In other words, a novice to accessibility should feel as comfortable proposing recommendations and Pull Requests as an expert. If a contributor is unable to seek out or afford accessibility consultation an Accessibility Advisor will be appointed to them by the _________ in the form of _________________. From 96192a1f70ce5529f7f14008ece544fd3610a34c Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Sat, 1 Jul 2017 16:31:21 +0200 Subject: [PATCH 7/8] Update a11y-mandate.md --- proposed/a11y-mandate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposed/a11y-mandate.md b/proposed/a11y-mandate.md index 2230e90..d8bb6f1 100644 --- a/proposed/a11y-mandate.md +++ b/proposed/a11y-mandate.md @@ -42,7 +42,7 @@ To provide all MODX users the ability to author and publish the web. ## Recommendation MODX enables site builders to not only create amazing experiences but also the creative freedom necessary to ensure the sites they create are accessible to all users. Unfortunately, to date the experience of building with MODX is not accessible to all users. Breaking changes allow the opportunity to adopt guidelines and ensure future major versions are truly accessible. -[Accessibility is water](https://modx.today/posts/2016/02/accessibility-is-water); we are all equally deservant of it. With breaking changes following this recommendation, we'll irrigate accessibility entirely througout our diverse and global community. +[Accessibility is water](https://modx.today/posts/2016/02/accessibility-is-water); we are all equally deserving of it. With breaking changes following this recommendation, we'll irrigate accessibility entirely througout our diverse and global community. > “Accessibility is a blueberry muffin. You can’t push the blueberries in afterwards.” From 3eed36ccda1d70c848d9a63d2d6df50467bbe167 Mon Sep 17 00:00:00 2001 From: JP DeVries Date: Sat, 1 Jul 2017 16:32:40 +0200 Subject: [PATCH 8/8] Update a11y-mandate.md --- proposed/a11y-mandate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposed/a11y-mandate.md b/proposed/a11y-mandate.md index d8bb6f1..e0f3f31 100644 --- a/proposed/a11y-mandate.md +++ b/proposed/a11y-mandate.md @@ -42,7 +42,7 @@ To provide all MODX users the ability to author and publish the web. ## Recommendation MODX enables site builders to not only create amazing experiences but also the creative freedom necessary to ensure the sites they create are accessible to all users. Unfortunately, to date the experience of building with MODX is not accessible to all users. Breaking changes allow the opportunity to adopt guidelines and ensure future major versions are truly accessible. -[Accessibility is water](https://modx.today/posts/2016/02/accessibility-is-water); we are all equally deserving of it. With breaking changes following this recommendation, we'll irrigate accessibility entirely througout our diverse and global community. +[Accessibility is water](https://modx.today/posts/2016/02/accessibility-is-water); we are all equally deserving of it. With breaking changes following this recommendation, we'll irrigate accessibility entirely throughout our diverse and global community. > “Accessibility is a blueberry muffin. You can’t push the blueberries in afterwards.”