argoproj / argo-cd

Declarative Continuous Deployment for Kubernetes
https://argo-cd.readthedocs.io
Apache License 2.0
18.04k stars 5.51k forks source link

Use inclusive names for resource fields #12657

Open pierDipi opened 1 year ago

pierDipi commented 1 year ago

Summary

As CNCF suggests the Inclusive Naming Initiative Announces New Community Resources for A More Inclusive Future [1] [2] has the goal of creating a more inclusive and welcoming community.

Unfortunately, Argo CD uses clusterResourceWhitelist or namespaceResourceBlacklist in the AppProject resource [3], but there might be others that I've not come across in the Argo project ecosystem.

Motivation

See [1] and [2] for the motivations.

Proposal

Rename fields to follow the CNCF guidelines for inclusive naming, for CRDs renaming means:

For this particular issue, I'd focus on the overall idea and, then, if accepted, open follow up issues to discuss the specific alternative names for a particular resource.

Eventually, to avoid regressions https://github.com/reviewdog/reviewdog can be used to prevent the non-inclusive language usage in the future.

[1] https://www.cncf.io/announcements/2021/10/13/inclusive-naming-initiative-announces-new-community-resources-for-a-more-inclusive-future/ [2] https://inclusivenaming.org/ [3] https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/

crenshaw-dev commented 1 year ago

We could start by offering the new name as an alternative in the current CRD. That would let folks fix their internal code.

Then we can remove the old fields in 3.0.