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

🌐 Accessible Setup ♿️ #14

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions proposed/a11y-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 🌐 Accessible Setup ♿️

_Note: This recommendation is a DRAFT for consideration of the MODX Advisory Board._

The MODX Advisory Board recommends, in an effort to make an accessible first impression, a new more inclusive setup process will expose accessibility preferences during the installation process.
🔧🤘

**Editor: JP de Vries**
**First published draft: Nov 26, 2016**

## 🙏 Goals of Recommendation

- To ensure that any accessibility preferences that may make the MODX Manager interface more accessible to users are accessible themselves during the installation setup process
- To reimagine the setup process to be more end–user friendly (more accessible and less technical language)

## 📚 Relevant Recommendations

- [Bandwidth Considerations](https://github.com/modxcms/mab-recommendations/pull/4)
- [Accessibility Mandate](https://github.com/modxcms/mab-recommendations/pull/3)
- [Progressive Icons Proposal](https://github.com/modxcms/mab-recommendations/pull/1)

## 🎯 Proof of Concepts
- [MODX Setup](https://github.com/jpdevries/modx-setup#demo)
- [Screencast](https://vimeo.com/218397030)

## 📝 Recommendation
👤 If preferences to improve the accessibility of the MODX manager are managed through system settings, these preferences themselves might not be accessible to the user. Whether these preferences relate to contrast, font-size, reduced animations or fully optimised manager themes, if the user is unable to configure such options, those features do not exist to them. Therefore, accessibility preferences must also be configurable from an accessible setup.

🎩 The most efficient user action is no action at all. The MODX setup intaller and default theme should "automagically" respond to relevant system level preferences such as high contrast mode, legibility preferences, and the presence of the `save-data` header. Users who are not familiar with system level preferences, or cannot access them, or for some reason choose to override them, benefit from also being able to manage these preference within MODX.

⌛️ This recommendation should not increase the amount of time it takes to install MODX. For example, these options could be hidden behind a button or&nbsp;`<summary>`.

🎓&ensp;Someone who has a Masters Degree in Computer Science and just found out what MODX is 5 minutes ago, and is now trying to install it, is contextually a cognitively disabled MODX user. They don't know what MODX Extras are, let alone the right ones they need to install to get what they want done. It may take them days of trial and error and research to learn the MODX Extra ecosystem. The installation complete screen should allow users to specify what they will be building and automatically install the Extras they'll need. No longer will you need knowledge of the MODX Extras ecosystem. You just tell MODX what you want to&nbsp;build.

📆&ensp;This recommendation target the first non&ndash;ExtJS version of&nbsp;MODX.