[Masthead]: Default to the correct translation endpoint for application calling just lc/language code in the URL parameter - Githubissues

carbon-design-system / carbon-for-ibm-dotcom

Carbon for IBM.com is based on the Carbon Design System for IBM

https://www.ibm.com/standards/carbon/

Apache License 2.0

269 stars 156 forks source link

[Masthead]: Default to the correct translation endpoint for application calling just lc/language code in the URL parameter #7060

Closed proeung closed 2 years ago

proeung commented 3 years ago

The problem

The cloud.ibm.com/docs application is currently loading just the language code within its ?locale= parameter (eg. https://cloud.ibm.com/docs?locale=es) where other content ecosystems like Drupal is using both lc and cc.
This is a feature that has not yet been accounted for in the Masthead component data fetching script.
Docs mentioned that altering their parameter to accept both lc and cc will requires some changes in their current translation files which they're not in the position to adjust.

The solution

Figure out a checking mechanism that fetches the correct translation without having the country code/cc in the URL parameter.

Screen Shot 2021-09-02 at 4 58 15 PM

RobertaJHahn commented 3 years ago

Included in the Sept 13 Engineering Issues Review meeting agenda.

RobertaJHahn commented 3 years ago

1) Convert to an epic. 2) Circle back with Linda to get an estimate from the translation team regarding the availability of the needed files

proeung commented 3 years ago

@jeffchew @RobertaJHahn Looks like this workaround (https://github.ibm.com/webstandards/ibm-dotcom-translations/pull/427) doesn't work for the Cloud Docs application (see slack thread). We might need to adjust the priority of this issue. Let me know what you both think.

RobertaJHahn commented 3 years ago

@proeung We will talk about this topic in our Adopter Issues review meeting tomorrow morning, 9/16. We have a dependency on translation files from another team, I'll update this issue when there is more information.

RobertaJHahn commented 3 years ago

1) The Locale service change: The locale API needs to add flexibility to only fetch the LC code 2) The Translation service api needs to pull the corresponding translation file if only lc is provided.

https://ibmdotcom-services.mybluemix.net/TranslationAPI.html

https://ibmdotcom-services.mybluemix.net/LocaleAPI.html

RobertaJHahn commented 3 years ago

Issues needed: 1 dev issue to update the services, Prod QA testing of both React & WC MH and Footer to ensure the existing capabilities are not broken. Putra will test by creating a test page that pulls the language code only

proeung commented 3 years ago

Once, the PR for this work is ready for review, please reach out to the Docs/KC team (Mark Kulube and Jenifer Schlotfeldt) to review and test the work within their application.

proeung commented 2 years ago

@RobertaJHahn @annawen1 Looks like the two issues that are associated with this EPIC have been closed. Is there anything else that we need to follow up on for this request? If not, I think we can close this issue out.

annawen1 commented 2 years ago

@RobertaJHahn @annawen1 Looks like the two issues that are associated with this EPIC have been closed. Is there anything else that we need to follow up on for this request? If not, I think we can close this issue out.

Yeah looks like we're good to go in closing this one. @RobertaJHahn?

RobertaJHahn commented 2 years ago

@proeung @annawen1 I assigned to the release, updated the Roadmap dates and closed. Thanks for the head-up.