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

Remove non-inclusive language #1373

Closed
Tracked by #1361 ...
dwelsch-esi opened this issue Apr 15, 2024 · 6 comments
Closed
Tracked by #1361 ...

Remove non-inclusive language #1373

dwelsch-esi opened this issue Apr 15, 2024 · 6 comments

Comments

@dwelsch-esi
Copy link
Contributor

Remove non-inclusive language throughout the documentation as recommended by the Inclusive Naming Initiative.

Use-Case

CNCF is among the organizations spearheading the adoption of more inclusive language in code and documentation.

Specification

The KEDA documentation is relatively free of non-inclusive language, but there are places that could be improved. Examples in KEDA:

@tomkerkhove
Copy link
Member

Thanks! Is this something you can contribute?

In terms of master I am afraid we can only change it once Redis has changed to to not confuse end-users more.

@zroubalik
Copy link
Member

Hi, thanks for raising this issue. Unfortunately the Redis case is not something we can fix, as it depends on Redis itself.

I personally don't think the other cases are non-inclusive, there's nothing harmful or offensive in them. If so, we would need to change half of the website:
Screenshot 2024-04-17 at 9 31 17

@dwelsch-esi
Copy link
Contributor Author

@tomkerkhove @zroubalik I understand the need to mirror the parameter names used by Redis. In the text, you can reject the term "master" without losing clarity by using, for example, a parenthetical explanation. For example, you could rewrite this:

"- sentinelMaster - The name of the master in Sentinel to get the Redis server address for."

To this:

"- sentinelMaster - The name of the primary (still referred to as the 'master' in Sentinel) to get the Redis server address for."

In place of "master", you can use "primary", "main", "original", "source", "controller" or any other term that most accurately conveys the function of the referent.

I didn't do an exhaustive search for non-inclusive terms, but I didn't find any tier 1 terms outside the Redis scaler doc. Re terms like "easy" and "simple", these terms aren't in the inclusive naming lists, but they are mentioned in the CNCF assessment criteria. As I understand it, the goal is to avoid ableist language, especially if it sounds dismissive or patronizing, like "Adjusting the threshold is a no-brainer; just change the scaleThresh value in the config file."

While I can't categorically agree with you that this particular ableist language is inoffensive, its usage here doesn't seem egregious. I respectfully take issue with "... we would need to change half of the website" as an argument to leave it as-is. There are cost/benefit tradeoffs to any change; this argument is another way of saying that inclusiveness should remain a low priority. Again, CNCF wants to be a leader in adopting more inclusive language in code and documentation.

@nate-double-u
Copy link
Contributor

To that point, the CNCF isn't mandating any of these changes—projects are always free to pick and choose which of the TechDocs analysis' recommendations to implement—but we do include a review of inclusive language as part of the process to help raise awareness.

@tomkerkhove
Copy link
Member

I don't have concerns if you open a PR with those recommendations. @zroubalik?

dwelsch-esi added a commit to dwelsch-esi/keda-docs that referenced this issue May 10, 2024
  - Moved some content from KEDA concept topics to Reference.
- Added a glossary, issue kedacore#1367
- Removed non-inclusive language, issue kedacore#1373

kedacore#1366
kedacore#1367
kedacore#1373

Umbrella issue for CNCF tech docs recommendations:
kedacore#1361

Signed-off-by: David Welsch <dwelsch@expertsupport.com>
nate-double-u pushed a commit to nate-double-u/kedacore-keda-docs that referenced this issue May 30, 2024
  - Moved some content from KEDA concept topics to Reference.
- Added a glossary, issue kedacore#1367
- Removed non-inclusive language, issue kedacore#1373

kedacore#1366
kedacore#1367
kedacore#1373

Umbrella issue for CNCF tech docs recommendations:
kedacore#1361

Signed-off-by: David Welsch <dwelsch@expertsupport.com>
@tomkerkhove
Copy link
Member

Closed in #1389

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

4 participants