Call-for-Code-for-Racial-Justice / Truth-Loop

The Truth-Loop solution helps communities simply understand the policies, regulations and legislation that will impact them the most and allows them to share their experiences around how policies have impacted them or how proposed policies could impact them using short video testimonials.
https://developer.ibm.com/tutorials/truth-loop/
Apache License 2.0
54 stars 29 forks source link

Replace text in the client app with internationalizing formatter calls to expedite translation #242

Closed ed-snodgrass closed 2 years ago

ed-snodgrass commented 3 years ago

Background on the problem the feature will solve/improved user experience

When users come to the application we want them to be able to read text in the language they're most comfortable. In order to do this we must replace all plain text displays with calls to the internationalization formatter. At the time of this issue being created that is react-intl. You may see examples in the client app by looking for intl.formatMessage

Describe the solution you'd like

Display text should be moved to the /src/nls/messages/en/messages.js file and then properly looked up from there by the component.

Tasks

For each piece of text being moved

Acceptance Criteria

All of the remaining display text (text the user sees) has been moved to the English translation file. Tests exist for the items moved.

github-actions[bot] commented 2 years ago

:wave: Hi! This issue has been marked stale due to inactivity. If no further activity occurs within the next 7 days, it will automatically be closed.

ed-snodgrass commented 2 years ago

@Fiewor

An example of where it is used: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/privacyNotice/PrivacyNotice.js

Where the english translations are stored: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/nls/messages/en/messages.js

Here is an example of where you can start: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/PolicyNotice.js basically replace Policy Notice with {intl.formatMessage(messages.policyNotice)} and add a policyNotice: 'Policy Notice' into the messages.js file. Hint: it has to be there for the en because that is default.

Fiewor commented 2 years ago

Collaborator

@Fiewor

An example of where it is used: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/privacyNotice/PrivacyNotice.js

Where the english translations are stored: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/nls/messages/en/messages.js

Here is an example of where you can start: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/PolicyNotice.js basically replace Policy Notice with {intl.formatMessage(messages.policyNotice)} and add a policyNotice: 'Policy Notice' into the messages.js file. Hint: it has to be there for the en because that is default.

I've implemented this in the starting point you suggested (i.e. PolicyNotice.js) but I can't seem to find other places within the client that haven't already had this done. In the mean time should I just push my changes?

ed-snodgrass commented 2 years ago

I say create a pull request and in the meantime I'll look for other spots. Thank you!

On Thu, Feb 17, 2022, 7:48 AM Fiewor John @.***> wrote:

Collaborator

@Fiewor https://github.com/Fiewor

An example of where it is used: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/privacyNotice/PrivacyNotice.js

Where the english translations are stored: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/nls/messages/en/messages.js

Here is an example of where you can start: https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/blob/main/client/src/PolicyNotice.js basically replace Policy Notice with {intl.formatMessage(messages.policyNotice)} and add a policyNotice: 'Policy Notice' into the messages.js file. Hint: it has to be there for the en because that is default.

I've implemented this in the starting point you suggested (i.e. PolicyNotice.js) but I can't seem to find other places within the client that haven't already has this done. In the mean time should I just push my changes?

— Reply to this email directly, view it on GitHub https://github.com/Call-for-Code-for-Racial-Justice/Truth-Loop/issues/242#issuecomment-1042967214, or unsubscribe https://github.com/notifications/unsubscribe-auth/AASQF7KAXPXFSBQ7LHS3MFDU3T4BPANCNFSM5G7EWM2A . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

You are receiving this because you authored the thread.Message ID: @.*** com>

github-actions[bot] commented 2 years ago

:wave: Hi! This issue has been marked stale due to inactivity. If no further activity occurs within the next 7 days, it will automatically be closed.