docs: new style guide - Inclusive Language

[BhaswatiRoy]

Fix: #1248

Added Style Guide for Inclusive Language -

1. Culturally Inclusive Language
2. Gender Neutral Language
3. People First Language
4. Slang Free Language
5. Ageism Free Language
6. Knowledge Assumption Free Language

[netlify]

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	4ba58b4
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/648bfc17ebb52e00085dbc4d
😎 Deploy Preview	https://deploy-preview-1327--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[BhaswatiRoy]

thanks @starlightknown for the suggestions, I have made the required changes

[quetzalliwrites]

Yes @BhaswatiRoy ... I forgot to remind you earlier that each new docs page and section needs:

1. metadata
2. _sections.md
3. index.md

➡️➡️ can you add those to your PR? :)

[github-actions]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	54
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🔴 PWA	30

Lighthouse ran on https://deploy-preview-1327--asyncapi-website.netlify.app/

[quetzalliwrites]

This section is titled slang, but focuses on vulgar language.

Slang and vulgar language are not the same, although they certainly may overlap in some cases. Slang refers to informal words or expressions that are often used in specific communities or groups, and it can be considered more casual or colloquial than standard language. (Slang terms are not inherently vulgar or offensive.)

On the other hand, vulgar language refers to language that is considered crude, obscene, or offensive. It often includes swear words, sexually explicit language, and may be considered inappropriate in certain contexts or situations. Vulgar language can be slang, but not all slang is vulgar.

ACTION ITEMS:

1. Please fix this section and re-write it to actually focus on slang topic with dedicated slang examples.
2. Please add an additional section and header for vulgar, which is it's own topic that deserves it's own examples. Please remember to be cautious what examples you add to this section and be mindful to select examples that do not make the community feel triggered or offended.

[quetzalliwrites]

Here are some examples of incorrect slang terms and corrected alternatives to help you get started! ✨

Incorrect Slang Terms:

• "Crazy" - using this term to describe something unusual or unexpected is stigmatizing and offensive to people with mental health conditions.
• "Lame" - using this term to describe something boring or uncool is hurtful to people with disabilities.
• "Gay" - using this term as an insult or to describe something negative or undesirable is homophobic and offensive to the LGBTQ+ community.
• "Redneck" - using this term to describe someone from a rural area can be pejorative and offensive.
• "Ghetto" - using this term to describe something low-quality or undesirable can be stigmatizing and offensive to people living in poverty or urban areas.

Corrected Alternatives:

• "Unusual," "unexpected," or "surprising"
• "Boring," "uncool," or "uninteresting"
• Use language that is not insulting or offensive to any particular group. For example, instead of saying, "that's so gay," you could say, "that's not my thing," or "that's not cool."
• "Rural," "country," or "small town"
• "Low-quality," "undesirable," or "run-down"

source: This is the edited version of the query reply I received from ChatGPT when I asked it for 5 ideas of incorrect slang terms and corrected alternatives.

[thulieblack]

I would like to see a section addressing accessibility and disability. I think it is very important to also highlight this

Here is an additional resource
https://atlassian.design/content/inclusive-writing

[Barbanio]

I love the proposal of this PR. It's so important ✨

[quetzalliwrites]

I would like to see a section addressing accessibility and disability. I think it is very important to also highlight this

Great feedback idea, thank you dear @thulieblack. To clarify, what do you think goes in a Style Guide section for accessibility and disability? Do you have points in mind we should cover? I would like to know specifically what examples you think are needed, besides adding alt- attributes to imgs.

cc @BhaswatiRoy, how about you? what do you think? :)

[thulieblack]

Great feedback idea, thank you dear @thulieblack. To clarify, what do you think goes in a Style Guide section for accessibility and disability? Do you have points in mind we should cover? I would like to know specifically what examples you think are needed, besides adding alt- attributes to imgs.

Cover points on ableism or words that are insensitive to people with disabilities. But now come to think of it shouldn't we separate or rename the people-first section to focus on this topic?

[BhaswatiRoy]

I would like to see a section addressing accessibility and disability. I think it is very important to also highlight this

Here is an additional resource https://atlassian.design/content/inclusive-writing

Hello @thulieblack, I have addressed accessibility & disability under "People first language", do you still want me to create a different section for that???

[thulieblack]

Hello @thulieblack, I have addressed accessibility & disability under "People first language", do you still want me to create a different section for that???

Okay, I think we should rename the section. In the body of the section, we then emphasize why it is important to use people's first language and list your examples wdyt?

[BhaswatiRoy]

Hello @thulieblack @alequetzalli, I have made the changes. It would be great if you could review and let me know if I missed anything

[quetzalliwrites]

Nicely written guidelines for promoting inclusive language in AsyncAPI documentation! ✨✨

This latest draft shows immense improvement from the previous one; thank you for your time and dedication. 💪🏿

Some work is still left to do, but you're almost there.

[quetzalliwrites]

Heyo, your directory structure is wrong because it's missing a dash to separate the words style-guide. 😄 Your directory needs to be:
asyncapi.com/docs/community/style-guide/grammar.

[quetzalliwrites]

P.S. I didn't mention this before because we JUST merged our new Community content bucket into the docs this week... but now that we have a LIVE Community content bucket in the docs, we actually should be authoring community docs directly in the /Community repo. (We actually have similar behavior/process in place for tools and specification docs too! Tools and specification docs are actually stored in their repoes and then copies to our website repo docs.)

I would work on your second draft and create a NEW PR in the community repo when you have it ready to review.

Please let me know if this doesn't make sense!