egeria-docs icon indicating copy to clipboard operation
egeria-docs copied to clipboard

Include a section on inclusive language in the style guide.

Open davidradl opened this issue 4 years ago • 8 comments

davidradl avatar Aug 24 '21 08:08 davidradl

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?

cmgrote avatar Aug 24 '21 16:08 cmgrote

@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 avatar Aug 25 '21 08:08 davidradl

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

davidradl avatar Aug 25 '21 08:08 davidradl

@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 avatar Aug 25 '21 09:08 adinh808

@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?

adinh808 avatar Aug 27 '21 17:08 adinh808

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").

cmgrote avatar Aug 27 '21 19:08 cmgrote

@adinh808 Is this enough info for you to proceed?

davidradl avatar Sep 23 '21 13:09 davidradl

@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?

adinhtdsibm avatar Sep 23 '21 17:09 adinhtdsibm