SUSE / doc-styleguide

SUSE Documentation Style Guide
https://susedoc.github.io/doc-styleguide/main/html/style-guide/
Other
14 stars 2 forks source link

Add a section for conscious language #286

Closed Amrita42 closed 5 months ago

Amrita42 commented 9 months ago

Do we need a section specific for conscious language , to avoid terms like master/slave or balcklist/whitelist and the prefered terms ind documentation (not source code)?

Similar to https://redhat-documentation.github.io/supplementary-style-guide/#conscious-language

janajaeger commented 7 months ago

We already have a stub on this: https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-bias which I personally find quite sufficient. We already have longish wordlist in the styleguide. No need to open yet another one. I bet, we are already paying attention to the rules maintaining the other wordlist?

Amrita42 commented 6 months ago

Yes I am aware but I feel imo , instead of browsing through the entire inclusive naming link , it would be good to have at the least the main words followed by a link .

jfaltenbacher commented 6 months ago

TermWeb also covers some of the inclusive naming recommendation, maybe an info to check in TW can be added to the style guide (in general, we could mention TW more often in the style guide as it is now available)

dariavladykina commented 6 months ago

@jfaltenbacher Shall I give the link to this address for TW? https://suse.termweb.eu/search/terms

jfaltenbacher commented 6 months ago

yes, great idea. The short form https://suse.termweb.eu/ should be sufficient. Maybe you need to add a note that this only works for SUSE employees and external partners with a SUSE account (https://www.suse.com/account/create/)

Amrita42 commented 6 months ago

Just one query is here , our style guide is a public repository and TermWeb is like Julia mentioned private so should we be adding a private link which is selectively accessible.

jfaltenbacher commented 6 months ago

I believe it is sufficient to mention that visiting this link requires a SUSE account (which is available to all employees by default and can be requested for externals at https://www.suse.com/account/create/)

dariavladykina commented 5 months ago

Closing as the required changes were merged.