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.

Sign up for GitHub

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

Jump to bottom

[Docs] Internationalization docs #2741

Merged

dpatil-magento merged 11 commits into develop from jimothy/pwa-930_i18n-l10n-docs

Oct 7, 2020

Contributor

jcalcaben commented Sep 30, 2020

Description

Creates a new Internationalization topic that provides an overview of the I18n framework in PWA Studio.

Related Issue

Closes PWA-930

Related to work done in #2696

Acceptance

@davemacaulay or anyone in the owls team
Any other untitled geese developer

Verification Stakeholders

@davemacaulay or anyone in the owls team
Any other untitled geese developer

Specification

Verification Steps

Navigate to the pwa-devdocs directory: cd pwa-devdocs
Start the html preview server: yarn develop
Navigate to: /technologies/basic-concepts/internationalization/
Verify page exists
Verify navigation entry is highlighted on the left navigation

Screenshots / Screen Captures (if appropriate)

Checklist

I have added tests to cover my changes, if necessary.

I have updated the documentation accordingly, if necessary.

jcalcaben added 5 commits

September 24, 2020 09:27


          Create new i18n topic

193f40e


          Add first section

f857d61


          Add content

116eed5


          Finish draft

814a817


          Minor fixes

6c47458

jcalcaben added pkg:pwa-devdocs documentation version: Minor docs labels

Contributor

PWAStudioBot commented Sep 30, 2020 •

edited

Loading

	Messages
📖	Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.
📖	DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).
📖	Associated JIRA tickets: PWA-930.

Generated by 🚫 dangerJS against 6802630

sirugh requested changes

View reviewed changes

Contributor

sirugh left a comment

This is a nice summarization! A few comments but I'm pretty happy with it as is.

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md

+              - The package contains an `i18n` directory
+              - The `i18n` directory contains a dictionary file with a locale formatted name
+              <!-- TODO: Create an in-depth tutorial for creating a language package extension -->

Contributor

sirugh Oct 5, 2020

Isn't there an example repo @davemacaulay created for this? Not sure if it's public but would be trivial to make one and just link it, I'm sure.

Contributor

davemacaulay Oct 5, 2020

Yes we have https://github.com/magento-research/pwa-studio-target-experiments/tree/2939ebf9af871f8ad43739554ad91e31afc49963/packages/i18n-package and a PR to get it merged here: magento-research/pwa-studio-target-experiments#2

Contributor Author

jcalcaben Oct 7, 2020

since it's not merged into mainline yet, I can't add a link to it. maybe when I do the tutorial I can add it.

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Show resolved Hide resolved

m2-community-project bot assigned sirugh

m2-community-project bot added the Progress: changes requested label

m2-community-project bot assigned jcalcaben

m2-community-project bot added Progress: review and removed Progress: changes requested labels


          Update content based on feedback

6fc1068

jcalcaben requested a review from sirugh

October 5, 2020 16:50

sirugh previously approved these changes

View reviewed changes

Contributor

sirugh left a comment

LGTM!


          Merge branch 'develop' into jimothy/pwa-930_i18n-l10n-docs

b07e9bf

m2-community-project bot assigned davemacaulay

davemacaulay suggested changes

View reviewed changes

Contributor

davemacaulay left a comment

This looks like a good first pass, a fair few comments to get this in line with our original thinking. I think we can also rely on an issue I originally created to provide more context on our decision making: #669 (comment)

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated

Comment on lines 148 to 149

		If a components changes the value of the current locale during runtime, the framework sends a GraphQL query to verify the new value.
		Even if you install a language package plugin for a locale, you must enable the locale on the backend to use the translations in the storefront UI.

Contributor

davemacaulay Oct 5, 2020

What is this concerning? We don't do any GraphQL queries for individual string changes during development. Be good if you can clarify which feature you mean by this.

Contributor

sirugh Oct 5, 2020

I wanted to make sure we covered our bases in terms of what minimum requirements are met in order to enable and use translations in the UI. If a user makes an i18n/fr_FR.json they can't just display French right? They'd have to enable it in the backend so that it shows up in the locale switcher that @eug123 has created.

Contributor Author

jcalcaben Oct 7, 2020

additional clarification provided

Contributor

davemacaulay Oct 7, 2020

Thanks for explaining @sirugh!

pwa-devdocs/src/technologies/basic-concepts/internationalization/index.md Outdated Show resolved Hide resolved


          Changes based on feedback

2369d61

jcalcaben dismissed sirugh’s stale review via

2369d61

October 6, 2020 21:31

jcalcaben requested a review from davemacaulay

October 7, 2020 14:42

davemacaulay approved these changes

View reviewed changes


          Merge branch 'develop' into jimothy/pwa-930_i18n-l10n-docs

56422a6


          Merge branch 'develop' into jimothy/pwa-930_i18n-l10n-docs

c9778a9

Contributor

dpatil-magento commented Oct 7, 2020

Verification steps pass.


          Merge branch 'develop' into jimothy/pwa-930_i18n-l10n-docs

dpatil-magento merged commit 57def6a into develop

dpatil-magento deleted the jimothy/pwa-930_i18n-l10n-docs branch

October 7, 2020 18:00

m2-community-project bot added Progress: done and removed Progress: review labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation pkg:pwa-devdocs Progress: done version: Minor