search

odpi / egeria-docs

Documentation repository for the Egeria project.
https://egeria-project.org
Other
23 stars 31 forks source link

Include a section on inclusive language in the style guide. #24

Open davidradl opened 3 years ago

cmgrote commented 3 years ago

Thanks for raising -- as discussed, can you check whether we can re-use something as a starting point and update the issue with your findings?

davidradl commented 3 years ago

@adinh808 is looking into this. I will assign once he says he wants to do this and has updated this issue with a comment.

davidradl commented 3 years ago

I notice this https://wiki.lfnetworking.org/display/LN/Inclusive+Language+Initiative as relevant

adinh808 commented 3 years ago

@davidradl I can work on this and have verified the links given as reference. Let me collate the information that I have gathered and will post here. I may provide info by Aug 28th unless you consider this as high priority Issue.

adinh808 commented 3 years ago

@davidradl This is from one of the IBM repo, https://github.com/IBM/IBMInclusiveITLanguage/blob/main/README.md which is also more relevant to the link that you posted. We can review both of the links and I can create a draft PR for reference to see how the wording could be. Also, please do let me know to which page this will be linked? Is this a new page or added to an existing page?

cmgrote commented 3 years ago

I would add it as a section in the Style Guide: https://odpi.github.io/egeria-docs/guides/documentation/style/

Primarily give the table of terms and replacements, with maybe 1 paragraph explaining the rationale (imho the the linked IBM site is too verbose on explaining "why" which takes attention from the "what" / "how").

davidradl commented 3 years ago

@adinh808 Is this enough info for you to proceed?

adinhtdsibm commented 3 years ago

@davidradl Which link should I refer to? Should I take content from https://wiki.lfnetworking.org/display/LN/Inclusive+Language+Initiative and use it in https://odpi.github.io/egeria-docs/guides/documentation/style/ ? and also add some of the content in IBM's link as well?