Thanks to Angelique for the summary and for creating a JEP based on the previous discussions and Google Docs. JEP-16 - Inclusive terminology guidelines and continuous updates <https://github.com/jenkinsci/jep/tree/master/jep/16> has been accepted as a draft, and we can keep evolving it. Any feedback will be welcome!
The Inclusive naming initiative is now also listed on the Advocacy&Outreach page: https://www.jenkins.io/sigs/advocacy-and-outreach/#inclusive-naming Best regards, Oleg On Wednesday, June 23, 2021 at 8:40:48 AM UTC+2 [email protected] wrote: > Hello all :) > > As a developer at CloudBees I am part of a team that is trying to > participate in the terminology change effort and we had the same concern > about the limits of changes (UI, logs, console, local variable, package > name ??). So I can share our way of working so far => > > What we do first, is change only UI text and log/console text because it's > fast with an immediate very visible change for end users and with very few > backward compatibility issues (mainly test assertions to update). > > We also changed the text in the comments, since the more terms are > changed, the easier it is to see if there are some places with remaining > deprecated words (so github search is faster). > > I personally think that the ultimate goal would be to have the deprecated > words removed everywhere including in code BUT this is complex to not break > any backward compatibility. > > I believe that anyone is free to go further, by being careful on backward > compatibility because any piece of code can be user visible at some point, > it can be a package name used on System property, a local field > automatically exposed by Jenkins configuration as Code and or some future > feature. > > For code change we are looking one by one and see if it’s possible to have > a backward compatible way, mainly by keeping along the old terminology and > the new one. For example for Jenkins cli or Configuration as Code it’s > quite easy to keep the deprecated terminology working as previously and > just mark it as deprecated and in the same time adding the same code > execution with the new naming convention. And remove the deprecated > terminology, later, one day…. If I come up with ways that works fine (for > cli or config as code or....) I will share them to the JEP I think. > > I also believe in small steps so I think it's better to split UI text > changes and code change it make it more easy to review and test. > On Wednesday, June 23, 2021 at 8:03:47 AM UTC+2 Oleg Nenashev wrote: > >> +1 to what Gavin said. I cannot comment on a particular EPIC, but >> renaming classes is generally in the scope for the terminology cleanup >> initiative: >> https://community.jenkins.io/t/jenkins-terminology-cleanup-initiative-coordination/180#full-scope-5 >> >> "Being in scope" does not mean it will happen soon. All Jenkins >> initiatives depend on contributions, and the time many individual and >> company contributors are willing to invest. I totally agree with Gavin that >> user-facing items should be a priority. Then it should be developer facing >> things, where possible and feasible. If any contributor or end user has >> strong opinions about fixing a particular occurrence, they are welcome and >> encouraged to go ahead and submit pull requests. Lower priority does not >> mean the things should not be fixed now, everyone can work as they prefer. >> >> >> >> On Wed, Jun 23, 2021 at 7:27 AM 'Gavin Mogan' via Jenkins Developers < >> [email protected]> wrote: >> >>> If a class name is serialized or used external to the plugin, its super >>> hard to change without breaking compatibility. Generally the initial push >>> is for using facing changes. Text strings, Help files. Docs. Etc >>> >>> On Tue, Jun 22, 2021 at 6:35 AM 'Fritz Elfert' via Jenkins Developers < >>> [email protected]> wrote: >>> >>>> On 22.06.21 12:01, Oleg Nenashev wrote: >>>> > Hi all, >>>> > >>>> > I am currently updating roadmap and the Jenkins website to reference >>>> the initiative and contributing. >>>> > To group everything and to coordinate contributions, I have created a >>>> Discourse topic here: >>>> https://community.jenkins.io/t/jenkins-terminology-cleanup-initiative-coordination/180 >>>> >>>> < >>>> https://community.jenkins.io/t/jenkins-terminology-cleanup-initiative-coordination/180> >>>> . >>>> I will be using it as a main source of contributing guidelines. Please >>>> feel >>>> free to contribute! >>>> >>>> What is still unclear to me (asked you in >>>> https://issues.jenkins.io/browse/JENKINS-62833) but no answer yet): >>>> Does this also include java class names or only user-visible >>>> text/messages/doc? >>>> >>>> Thanks >>>> -Fritz >>>> > >>>> > Best regards, >>>> > Oleg Nenashev >>>> > >>>> > On Wednesday, May 19, 2021 at 8:36:41 PM UTC+2 [email protected] >>>> wrote: >>>> > >>>> > On Wed, May 19, 2021 at 8:08 AM 'Gavin Mogan' via Jenkins >>>> Developers <[email protected]> wrote: >>>> > >>>> > I'm actually against updating the changelog. The changes to >>>> terminology were not done then, and by showing the old and the new, you >>>> show growth. I'm not a fan of rewriting history, even in git. >>>> > >>>> > >>>> > We're not "rewriting history" here. You wouldn't leave some wrong >>>> formatting around after migrating a file from Markdown to Asciidoc (or >>>> vice >>>> versa). You'd fix old typos. You'd adapt old links when the URL of the >>>> pages they point to change. And if we change the words we use to refer to >>>> something, that applies retroactively as well. >>>> > >>>> > -- >>>> > You received this message because you are subscribed to the Google >>>> Groups "Jenkins Developers" group. >>>> > To unsubscribe from this group and stop receiving emails from it, >>>> send an email to [email protected] <mailto: >>>> [email protected]>. >>>> > To view this discussion on the web visit >>>> https://groups.google.com/d/msgid/jenkinsci-dev/bdbaa768-fcf4-45d1-924d-52be07a39c88n%40googlegroups.com >>>> >>>> < >>>> https://groups.google.com/d/msgid/jenkinsci-dev/bdbaa768-fcf4-45d1-924d-52be07a39c88n%40googlegroups.com?utm_medium=email&utm_source=footer >>>> >. >>>> >>>> -- >>>> You received this message because you are subscribed to the Google >>>> Groups "Jenkins Developers" group. >>>> To unsubscribe from this group and stop receiving emails from it, send >>>> an email to [email protected]. >>>> To view this discussion on the web visit >>>> https://groups.google.com/d/msgid/jenkinsci-dev/27bb0f2a-5995-d6a2-1f39-11aa1d6670cf%40fritz-elfert.de >>>> . >>>> >>> -- >>> >> You received this message because you are subscribed to a topic in the >>> Google Groups "Jenkins Developers" group. >>> To unsubscribe from this topic, visit >>> https://groups.google.com/d/topic/jenkinsci-dev/x5vdlJDvntw/unsubscribe. >>> To unsubscribe from this group and all its topics, send an email to >>> [email protected]. >>> To view this discussion on the web visit >>> https://groups.google.com/d/msgid/jenkinsci-dev/CAG%3D_DusJ-2QmVF2xsuLRzoFi3GG5KsNtv%3DEz2rBUNCwNbMeb%3DQ%40mail.gmail.com >>> >>> <https://groups.google.com/d/msgid/jenkinsci-dev/CAG%3D_DusJ-2QmVF2xsuLRzoFi3GG5KsNtv%3DEz2rBUNCwNbMeb%3DQ%40mail.gmail.com?utm_medium=email&utm_source=footer> >>> . >>> >> -- You received this message because you are subscribed to the Google Groups "Jenkins Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/1f8d59ef-af83-47b0-8553-c1330eeb6951n%40googlegroups.com.
