-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adjust Labels and Titles #2031
Adjust Labels and Titles #2031
Conversation
6861dfc
to
9165aad
Compare
Are we sure we want to do this? It is (1) a major breaking change regarding i18n and (2) does not contribute to make these menus more readable (i think). |
Good thing, of course, is that it'll now be somewhat consistent across our code-base. |
If we are to merge this, we should update the translations in https://github.com/bpmn-io/bpmn-js-i18n accordingly. I don't mean that we should fix the casing there, but rather update the keys to keep the old translations. |
Note that Polish translations already use sentence case: https://github.com/bpmn-io/bpmn-js-i18n/blob/main/translations/pl.js |
So changes would be: - "Add Lane above": "Dodaj pas powyżej",
+ "Add lane above": "Dodaj pas powyżej", |
BTW this PR shows that // in code
translate('BOUNDARY_EVENT')
// en.json
{
"BOUNDARY_EVENT": "Boundary event"
} Or even more convenient: // in code
translate('BOUNDARY_EVENT', /* dynamic values */ {}, /* English */ 'Boundary event')
// de.json
{
"BOUNDARY_EVENT": "Grenzereignis"
} |
@barmac This change will be reflected in a single commit, in the i18n repository, I hope. It will also be a breaking change for the library so integrators have to expect breaking things. I don't think that it will be much of a hazzle for our contributors to update, if we provide guidance ➡️ Blog is the minimum to ensure they have a chance. Even better updating the translation keys (we could have an old to new English translation). @philippfromme Please create a tracking issue to collect this and @barmac's thoughts, the repositories you touch and let's outline a roll-out strategy before merging this PR. It is a huge change (for some) and we want to handle it appropriately, with a little bit of planning. |
@nikku @barmac Please have a look at https://github.com/bpmn-io/internal-docs/issues/861 and let me know what you think. The refactoring proposed by @barmac could be a follow-up or done along with the adjustment of the labels. |
After we've decided not to change how translations work, this is ready to be reviewed. |
"Signal start event", | ||
"Signal start event (non-interrupting)", | ||
"Start event", | ||
"Sub-process", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the docs, it's treated as a single word: https://docs.camunda.io/docs/components/modeler/bpmn/subprocesses/
While in the specification, it takes form of "Sub-Process". I think the hyphened version is correct here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's take the specification as the reference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the spec it's Sub-process
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's clean up the commits.
Let's clearly mark this as a breaking change, so we don't forget the major version bump.
Let's turn this from chore
to feat
, as we believe (I believe) this is a significant improvement to the existing editor. We'd otherwise not ship it.
BREAKING CHANGE: * translations have changed
Adjusts labels and titles according to https://docs.google.com/document/d/1zuXLaRhNXdLa3Q4CV9J39-H5b22jDDwXotzfQV1ZsJw/edit#heading=h.bcw00wds71dr.