search

ansible / ansible-documentation

Ansible community documentation
https://docs.ansible.com/
GNU General Public License v3.0
76 stars 457 forks source link

D&I working group Docs Hackfest for inclusive language #812

Open jillr opened 3 years ago

jillr commented 3 years ago

Let's plan a docs hackfest to make language in our documentation more inclusive.

Some suggestions to look for: simple, simply, obvious,obviously, guy, guys, man in docs (ansible-base + collections)

ETA: If we can write up specific things to be fixed DaWGs can help us with either (or both) planning a docs day or pointing community members at the list as easy_fixes. This was done for the collections docs and worked well.

jillr commented 3 years ago

misc got the clc (conscious langauge checker) up and running last week: http://test-test-clc.apps.ospo-osci.z3b1.p1.openshiftapps.com/analysis.html?project=ansible.git

oraNod commented 10 months ago

Thanks for raising this issue. It's important and very worthwhile. We recently added spelling checks that use the codespell library. codespell also offers a dictionary for inclusive language that we can enable: https://github.com/codespell-project/codespell/blob/master/codespell_lib/data/dictionary_usage.txt

it would be as simple as adding usage to the list of dictionaries here: https://github.com/ansible/ansible-documentation/blob/devel/.codespellrc#L8

iirc we decided to hold off on including the usage dictionary from the codespell configuration because it is technically not a check for spelling and was deemed more suitable for a follow up.