Comments (6)
@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.
from keda-docs.
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.
from keda-docs.
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:
from keda-docs.
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.
from keda-docs.
I don't have concerns if you open a PR with those recommendations. @zroubalik?
from keda-docs.
Closed in #1389
from keda-docs.
Related Issues (20)
- Update the Operator Guide HOT 7
- Create a Reference Topic HOT 3
- Write a Glossary HOT 3
- Write a Procedure for Setting Up a Scaler HOT 8
- Make user roles explicit HOT 2
- Separate reference and task information HOT 2
- Update the doc content creation instructions HOT 2
- Clarify the KEDA website and documentation maintainers HOT 5
- Add documentation for new GCP Pub/Sub scaler options
- Selenium-Grid-Scaler : ScaledObject errors out when ServiceName has been used HOT 1
- Prometheus: `queryParameters` is an optional parameter
- Annotate existing scalers with metadata for easier filtering
- FAQ in v2.14+ does not show dropdown of older versions
- KEDA documentation around number of replicas supported for metrics server is contradictory HOT 10
- Inconvenient filtering due to scaler type not serving both by default HOT 1
- Provide visual difference between built-in and external scaler
- Misleading recommendation on Scaling Deployments section HOT 1
- Doc: Pubsub scaler, document relation between stabilizationWindowSeconds and metrics sample rate HOT 1
- Incorrect documentation regarding minimum version of TLS used
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from keda-docs.