Replace / remove use of potential condescending terms

[programmiri]

Description

Here's a great explanation what condescending language is and why we should remove it from our documentation: How to remove condescending language from documentation # Why

In short, using phrasing like for example: "It is easy to understand this concept." can make people feel inadequate if they don't immediately understand. We humans :D can tend to use that kind of wording from a good place - because we want to assure others that they can do it / don't have to feel intimidated. But we may do the opposite with it.

In order to make our documentation more welcoming, we would like to remove certain words from it, that may invoke that kind of condescending tone. We've added a tool that enables to automatically flag words that are often an indicator for this language. Since the tool can not identify the context, there's a human eye needed to check and formulate the text in a better way.

HowTo

We are using alexjs internally for this kind of linting. We don't have it as a dependency.

To use alexjs for highlighting words that could sound condescending, there are two ways for you:

1. install alexjs globally with pnpm add alex -g
2. go into directory /coral
3. run: pnpm exec find ../ . -type f -name "*.md" -not -path "*/node_modules/*" -exec alex {} \;

This will look for all files with the ending .md in all directories in root, but exclude "node_modules".

If you don't want to install it globally, you can:

1. go into directory /coral
2. run npx alex ../ .

Note: This will also check all .txt files. You can ignore all of those!

[flushthemoney]

I would like to solve this issue, kindly assign it to me.

[AnushkaPhogat16]

Hey! I'd like to work on resolving this issue. Please assign it to me. Thanks!

[programmiri]

Hi! @flushthemoney - I'll assign you to the issue. Please feel free to reach out if you have any questions :)

@AnushkaPhogat16 - if you want to, you could take a look at this issue from our documentation repository: Aiven-Open/klaw-docs#110

[flushthemoney]

Hey! I've sent in a PR, please verify and merge it.