Update split i18n strings to be more translatable

What does this MR do and why?

Update the format of i18n strings that have multiple parts formatted into an English language sentence so that they can be translated into other languages that don't use similar syntax.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

How to set up and validate locally

This is a difficult set of changes to test in the GDK, as they range widely.

For most changes, the change is only a change in the copy the user sees and has no mechanical/functional change. These changes have already undergone Technical Writing review.

Mechanically, I think special reviewer scrutiny is probably due to my changes in app/helpers/emails_helper.rb and its spec file /spec/helpers/emails_helper_spec.rb. Previously, this file only returned the reason part of a split internationalized string, but I have changed it to return the entire message.

These changes can be most conveniently reviewed by visiting the mailer preview app (http://gdk.test:3000/rails/mailers) and checking the contents of generated emails.

Emails impacted by my changes:

• http://gdk.test:3000/rails/mailers/notify/approved_merge_request_email
• http://gdk.test:3000/rails/mailers/notify/closed_issue_email
• http://gdk.test:3000/rails/mailers/notify/closed_merge_request_email
• http://gdk.test:3000/rails/mailers/notify/issue_status_changed_email
• http://gdk.test:3000/rails/mailers/notify/merge_request_status_email
• http://gdk.test:3000/rails/mailers/notify/merge_when_pipeline_succeeds_email

Related to #450712 (closed), #444717 (closed)

changed milestone to %16.11

added Category:Internationalization Category:Team Planning Localizability UI text UX bugux devopsplan groupproject management sectiondev severity4 typebug workflowready for development labels

assigned to @clavimoniere

added Technical Writing label

mentioned in issue #450712 (closed)

@msedlakjakubowski @opysaryuk have a look at my proposed updates to these strings please.

• From a Technical Writing perspective, any concerns or updates?
• From an i18n perspective, are there any strings I changed here that are still not fully translatable with proper syntax?

@clavimoniere from the i18n and translatability perspective, the message composition looks good.

One question: the _some_ text that's being injected via %{reason} seems to be lowercased programmatically. This behaviour is described with more detail here, with screenshots: #450712 (comment 1819488873). Would it be possible see what the newly proposed messages look like on the UI, in English? Does the MR address the character casing?

This MR doesn't at all, but if it should I can go look into that. I would expect that this was probably done because things were being made into an English language sentence, but it certainly seems like the casings used in the i18n strings should be what get to the user (esp for languages like German!)

@clavimoniere , do you think it's worth creating a new issue for that? I could create one. If there is indeed some forced uppercasing going on in code (maybe style like this, or something more complex), it may be a pattern in English, that affects all languages, that we'd need identify and undo.

@clavimoniere These changes look great, thanks!

do you think it's worth creating a new issue for that?

@opysaryuk yeah I think so, could you create one?

With a bit of a delay (sorry about it @clavimoniere ), I have created a follow up issue: Investigate if the %{reason} variable text is l... (#462661)

added backend frontend labels

	1 Warning
	This MR changes code in ee/, but its Changelog commit is missing the EE: true trailer. Consider adding it to your Changelog commits.

Reviewer roulette

Category	Reviewer	Maintainer
backend	@panoskanell (UTC+3, 7 hours ahead of author)	@dbalexandre (UTC+0, 4 hours ahead of author)
frontend	@nradina (UTC+2, 6 hours ahead of author)	@arfedoro (UTC+2, 6 hours ahead of author)
test for spec/features/*	@panoskanell (UTC+3, 7 hours ahead of author)	Maintainer review is optional for test for spec/features/*
UX	@nickleonard (UTC-5, 1 hour behind author)	Maintainer review is optional for UX
groupauthentication	Reviewer review is optional for groupauthentication	@dblessing (UTC-5, 1 hour behind author)

Please check reviewer's status!

• Reviewer is available!
• Reviewer is unavailable!

Please refer to documentation page for guidance on how you can benefit from the Reviewer Roulette, or use the GitLab Review Workload Dashboard to find other available reviewers.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

added 1 commit

• 1e65bc31 - Update split i18n strings to be more translatable

Compare with previous version

added 280 commits

• 1e65bc31...7f79834f - 279 commits from branch master
• f74e930c - Update split i18n strings to be more translatable

Compare with previous version

Bundle size analysis [beta]

This compares changes in bundle size for entry points between the commits 5074f4ea and 746789fd

Special assets

Entrypoint / Name	Size before	Size after	Diff	Diff in percent
average	4.32 MB	4.32 MB	-	-0.0 %
mainChunk	3.31 MB	3.31 MB	-	0.0 %

---

Note: We do not have exact data for 5074f4ea. So we have used data from: 1380b355.
The intended commit has no webpack pipeline, so we chose the last commit with one before it.

Please look at the full report for more details

---

Read more about how this report works.

Generated by Danger

added 1 commit

• a3b0cfb1 - Update split i18n strings to be more translatable

Compare with previous version

@msedlakjakubowski can you review the copy changes I've got here as well? I don't want to fix my failing tests until I have finalized copy to test against.

requested review from @msedlakjakubowski

approved this merge request

added twfinished workflowin dev labels and removed workflowready for development label

removed review request for @msedlakjakubowski

added pipeline:mr-approved label

@msedlakjakubowski, thanks for approving this merge request.

This is the first time the merge request has been approved. To ensure we don't only run predictive pipelines, and we don't break master, a new pipeline will be started shortly.

Please wait for the pipeline to start before resolving this discussion and set auto-merge for the new pipeline. See merging a merge request for more details.

E2E Test Result Summary

allure-report-publisher generated test report!

e2e-test-on-gdk: test report for 746789fd

expand test summary

+------------------------------------------------------------------+
|                          suites summary                          |
+-------------+--------+--------+---------+-------+-------+--------+
|             | passed | failed | skipped | flaky | total | result |
+-------------+--------+--------+---------+-------+-------+--------+
| Create      | 87     | 0      | 9       | 0     | 96    | ✅     |
| Govern      | 66     | 0      | 0       | 0     | 66    | ✅     |
| Data Stores | 31     | 0      | 0       | 0     | 31    | ✅     |
| Plan        | 51     | 0      | 2       | 0     | 53    | ✅     |
| Verify      | 35     | 0      | 1       | 0     | 36    | ✅     |
| Monitor     | 7      | 0      | 0       | 0     | 7     | ✅     |
| Package     | 24     | 0      | 6       | 0     | 30    | ✅     |
| Manage      | 0      | 0      | 1       | 0     | 1     | ➖     |
| Analytics   | 2      | 0      | 0       | 0     | 2     | ✅     |
| Release     | 5      | 0      | 0       | 0     | 5     | ✅     |
+-------------+--------+--------+---------+-------+-------+--------+
| Total       | 308    | 0      | 19      | 0     | 327   | ✅     |
+-------------+--------+--------+---------+-------+-------+--------+

e2e-package-and-test: test report for 746789fd

expand test summary

+------------------------------------------------------------------+
|                          suites summary                          |
+-------------+--------+--------+---------+-------+-------+--------+
|             | passed | failed | skipped | flaky | total | result |
+-------------+--------+--------+---------+-------+-------+--------+
| Plan        | 285    | 0      | 23      | 0     | 308   | ✅     |
| Create      | 181    | 1      | 21      | 2     | 203   | ❌     |
| Govern      | 28     | 0      | 0       | 0     | 28    | ✅     |
| Package     | 6      | 0      | 8       | 0     | 14    | ✅     |
| Monitor     | 8      | 0      | 0       | 0     | 8     | ✅     |
| Data Stores | 22     | 0      | 0       | 0     | 22    | ✅     |
| Release     | 2      | 0      | 0       | 0     | 2     | ✅     |
| Verify      | 18     | 0      | 0       | 0     | 18    | ✅     |
+-------------+--------+--------+---------+-------+-------+--------+
| Total       | 550    | 1      | 52      | 2     | 603   | ❌     |
+-------------+--------+--------+---------+-------+-------+--------+

added 1 commit

• d39bd509 - Update split i18n strings to be more translatable

Compare with previous version

added 693 commits

• d39bd509...14c0a4df - 692 commits from branch master
• f240b00f - Update split i18n strings to be more translatable

Compare with previous version

added 1 commit

• c69d9990 - Update split i18n strings to be more translatable

Compare with previous version

added 463 commits

• c69d9990...47bb6475 - 462 commits from branch master
• bec88f79 - Update split i18n strings to be more translatable

Compare with previous version

added 1 commit

• 6355cbd6 - Update split i18n strings to be more translatable

Compare with previous version

added 1 commit

• 0e227266 - Update split i18n strings to be more translatable

Compare with previous version

marked this merge request as ready

added 1 commit

• 6e34a548 - Update split i18n strings to be more translatable

Compare with previous version

added 1 commit

• a3f21bc6 - Update split i18n strings to be more translatable

Compare with previous version

changed the description

@cablett Do you mind doing a BE review here?

Sorry that my review steps are a little vague. As I said in the description I think the most scrutiny needed on my changes to emails_helper.

requested review from @cablett

Looks great so far @clavimoniere ! I just have a couple of questions here for your consideration. Let me know what you think!

added 1 commit

• 09f2628d - Update split i18n strings to be more translatable

Compare with previous version

@cablett @splattael thank you for your feedback! I've applied the easily applied suggestions here still a few questions in other threads.

EDIT: never mind that last part. Still an outstanding Technical Writing question but I've applied all your suggestions.

requested review from @cablett

added 1 commit

• 186c89b9 - Update split i18n strings to be more translatable

Compare with previous version

added 1 commit

• ec1b32cb - Update split i18n strings to be more translatable

Compare with previous version

changed milestone to %17.0

added 1 commit

• a912f49f - Update split i18n strings to be more translatable

Compare with previous version

mentioned in issue #456257 (closed)

@msedlakjakubowski thanks for the recommendations, just updated!

added 1 commit

• 034c885a - Update split i18n strings to be more translatable

Compare with previous version

added 1 commit

• 746789fd - Update split i18n strings to be more translatable

Compare with previous version

changed the description

@jrushford can you do a FE review here?

requested review from @jrushford

approved this merge request

requested review from @slashmanov and removed review request for @jrushford

approved this merge request

removed review request for @slashmanov

LGTM

approved this merge request

@tachyons-gitlab @sgarg_gitlab @bdenkovych @ifarkas are one of you able to please approve for groupauthentication ?

approved this merge request

requested review from @sgarg_gitlab

removed review request for @sgarg_gitlab

approved this merge request

The MR has all the required approvals. I am setting MWPS.

resolved all threads

enabled an automatic merge when the pipeline for 3920ab1a succeeds

merged

mentioned in commit 22d5b082

added workflowstaging-canary label and removed workflowin dev label

added workflowcanary label and removed workflowstaging-canary label

added workflowstaging label and removed workflowcanary label

added workflowproduction label and removed workflowstaging label

added releasedcandidate label

mentioned in issue gitlab-com/localization/issue-tracker#172 (moved)

mentioned in issue #462661

mentioned in merge request kubitus-project/kubitus-installer!3058 (merged)

added releasedpublished label and removed releasedcandidate label

added pipelinetier-3 label

mentioned in issue gitlab-com/localization/localization-team#144 (closed)

mentioned in issue gitlab-com/localization/localization-team#251 (closed)