A non-biased, community-driven, fact-based information sheet aimed at educating customers on web-accessibility overlays. This repo powers the site at https://overlayfactsheet.com/
Please note: The content of the Overlay Factsheet may change over time. Specifically, content may be added, edited, or removed to provide additional clarity, additional evidence, or other changes in keeping with the goal of sharing facts on overlays. Please understand this before requesting your signature be added. These changes are and will be made in a good faith effort to continue to raise awareness of overlays, their traits, strengths, and weaknesses. Please be sure to "Watch" this repo to review if any of the changes are consequential enough to change your endorsement.
Toward the bottom of the page in the /src/index.html
file is a heading that says "Signed by".
Below that is an ordered list (<ol>
);
Add your name as a <li>
in that list, in the following format: Name, Title, Organization. For example: Joe Schmoe, CEO, Acme Corp.
If you'd rather not put your title and organization down, that's fine. Feel free to do something like Joe Schmoe, self
Please do not add links in the endorsement section. This isn't an exercise in SEO for anyone, it is a statement of unity.
Please use the PR process described below, issuing your PR against the develop
branch.
If you want to modify an existing language, simply go to the corresponding file in the i18n/
folder, e.g. i18n/en.yml
(for english) and modify the contents. If a translation key doesn't exist, it automatically switches to english content.
If you want to add a new language, it's only a 2-step process:
hugo.toml
file, add the new language, e.g. spanish in third position
[languages]
[languages.en]
contentDir = 'i18n/en'
weight = 1
[languages.en.params]
languageName = 'english'
languageNameShort = 'en'
languageCode = 'en'
[languages.fr]
contentDir = 'i18n/fr'
weight = 2
[languages.fr.params]
languageName = 'français'
languageNameShort = 'fr'
languageCode 'fr'
[languages.es]
contentDir = 'i18n/es'
weight = 3
[languages.fr.params]
languageName = 'español'
languageNameShort = 'es'
languageCode = 'es'
i18n/
folder, add a yml file with the language shortname, e.g. i18n/es.yml
(if spanish), and translate each key in this file.Contributions to the design and/ or code are encouraged!
We follow a modified "git flow" type of workflow:
develop
branch that is solely focused on the issue you're working against.develop
develop
to main
.main
has passed, it will automatically deploy.Contributions of content will follow the exact same workflow as above.
Please note the following general content guidance: