Skip to content
This repository has been archived by the owner on Jan 9, 2023. It is now read-only.

Respectful code cleanup #1892

Open
avnishb opened this issue Jan 25, 2021 · 0 comments
Open

Respectful code cleanup #1892

avnishb opened this issue Jan 25, 2021 · 0 comments

Comments

@avnishb
Copy link
Contributor

avnishb commented Jan 25, 2021

Google has adopted a policy to use respectful terminology in our internal code and documentation, and the same should be true of our open source projects. We want our projects and communities to be welcoming to everyone, and part of creating an inclusive environment is being thoughtful in the language we use in our code and documentation.

In reviewing github.com/google/earthenterprise we found the following terms that should be avoided:

  • master
  • slave
  • blacklist
  • whitelist
  • Slave

These were found in the following files:

  • docs/geedocs/5.3.2/searchindex.js
  • docs/geedocs/5.3.8/sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.6/searchindex.js
  • docs/geedocs/5.3.7/searchindex.js
  • docs/geedocs/5.3.3/sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.4/sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.4/searchindex.js
  • earth_enterprise/rpms/opengee-fusion/snippets/post-install.sh
  • docs/geedocs/5.3.5/sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.3/searchindex.js
  • docs/geedocs/5.2.5/answer/3481558.html
  • docs/geedocs/5.3.6/raw_sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.2.1/answer/3481558.html
  • docs/geedocs/5.3.6/sources/answer/fusionAdministration/commandReference.rst.txt
  • earth_enterprise/docs/landing_page/previous_fusion_versions/4.4/apis/maps_api/apis/maps/documentation/mapplets/guide.html
  • docs/geedocs/5.3.3/raw_sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.3/answer/fusionAdministration/commandReference.html
  • docs/geedocs/5.3.7/answer/fusionAdministration/commandReference.html
  • docs/geedocs/5.3.4/raw_sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.8/searchindex.js
  • docs/geedocs/5.2.3/answer/3481558.html
  • earth_enterprise/src/installer/install_fusion.sh
  • docs/geedocs/docsrc/answer/fusionAdministration/commandReference.rst
  • docs/geedocs/5.3.4/answer/fusionAdministration/commandReference.html
  • docs/geedocs/5.3.1/answer/3481558.html
  • docs/geedocs/5.3.8/raw_sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.5/raw_sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.2/raw_sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.3.7/raw_sources/answer/fusionAdministration/commandReference.rst.txt
  • earth_enterprise/src/fusion/autoingest/sysman/khResourceManager.cpp
  • docs/geedocs/5.3.5/searchindex.js
  • earth_enterprise/src/fusion/config/geselectassetroot.cpp
  • docs/geedocs/5.3.7/sources/answer/fusionAdministration/commandReference.rst.txt
  • earth_enterprise/src/keyhole/proto/dbroot/dbroot_v2.proto
  • earth_enterprise/docs/landing_page/previous_fusion_versions/4.4/fusion/html/admin/commands.html
  • docs/geedocs/5.3.5/answer/fusionAdministration/commandReference.html
  • docs/geedocs/5.3.2/sources/answer/fusionAdministration/commandReference.rst.txt
  • docs/geedocs/5.2.4/answer/3481558.html
  • docs/geedocs/5.2.2/answer/3481558.html
  • docs/geedocs/5.3.0/answer/3481558.html
  • docs/geedocs/5.3.6/answer/fusionAdministration/commandReference.html
  • docs/geedocs/5.3.2/answer/fusionAdministration/commandReference.html
  • docs/geedocs/5.2.0/answer/3481558.html
  • docs/geedocs/5.3.8/answer/fusionAdministration/commandReference.html

Please take some time to see if these terms could be replaced with more respectful alternatives e.g.

blacklist, whitelist, graylist, greylist, black list, white list, gray list, grey list

Don't use blacklist, whitelist, and graylist (greylist). Instead, use more precise terms that are appropriate to your domain.

For blacklist, consider such replacements as denylist, excludelist, or blocklist.

For whitelist, consider such replacements as allowlist , trustlist, or safelist.

For graylist (greylist), consider such replacements as provisional list.

In all of these cases, consider that there may not actually be a list involved. When replacing problematic terms, be sure to be technically accurate for the specific context.

If the command or code you're documenting uses one of these words, then use these words only in direct reference to the code items (formatted as code), and make it clear what you're referring to.

master

Use with caution. Never use in conjunction with slave. Where possible, replace master with a specific term that is accurate for the context, such as primary, parent, initiator, driver, or leader. If the command or code that you're documenting uses the literal word master, then introduce the term to make it clear what you're referring to, and then use new term thereafter.

slave

Don't use slave. Use a replacement that best fits your product (for example, replica, secondary, or consumer). To replace master/slave, you can also use terms like parent/child, initiator/responder, leader/follower, primary/replica, or primary/standby.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant