Docs [Translation Scaling] Automate translation of localized navs

[roadlittledawn]

Summary

When on a localized page, the left nav is translated via looking for the English value in src/i18n/nav/{LOCALE}/{LOCALE}.json. Currently this file is only updated manually and is often neglected / forgotten when nav YAML files are updated.

For now run this on a schedule once every month.

Spec

• A script should convert all items in all relevant files in src/nav to JSON file with following shape.

Example: nav JSON for upload

Note: English values are used for both `title` and `englishTitle` fields. Full example in experimental branch Helpful links section below. ```js [ { "title": "Organizations and accounts", "englishTitle": "Organizations and accounts", "locale": "jp" }, { "title": "Accounts and billing", "englishTitle": "Accounts and billing", "locale": "jp" }, { "title": "Account setup", "englishTitle": "Account setup", "locale": "jp" }, { "title": "Sign up for New Relic", "englishTitle": "Sign up for New Relic", "locale": "jp" }, { "title": "Choose your data center", "englishTitle": "Choose your data center", "locale": "jp" }, { "title": "Troubleshoot password and login", "englishTitle": "Troubleshoot password and login", "locale": "jp" }, { "title": "Downgrade or cancel account", "englishTitle": "Downgrade or cancel account", "locale": "jp" }, { "title": "Release notes", "englishTitle": "Release notes", "locale": "jp" }, ] ```

• English value should be used for both title and englishTitle for the file that's uploaded to Smartling

Screenshots

Image: Localized left nav


Acceptance criteria

• [ ] Verify w/Julien if/how we can do this since it's a little different than other translation processes
• [ ] Verify that we want these human translated / which vendor project this should go in
• [ ] Create script that generates localized nav JSON (see example below) for each language and uses the English value for the title
• [ ] Removes any objects that only have English values for both title and englishTitle in it before PR-ing
• [ ] Create script that submits each languages nav JSON to translation vendor
• [ ] Create script that checks job status, downloads files, and PRs the repo
• [ ] Incorporate scripts into a github workflow that runs once a month
• [ ] Resulting PR adds @jmiraNR as reviewer automatically

Helpful link

• Example: JP nav
• started a script in clang/src-i18n-nav

[github-actions[bot]]

Hi @roadlittledawn 👋 Thank you for filing an issue! We'll triage your issue and let you know if we have questions, and then route it to the appropriate team so we can get it solved.

[roadlittledawn]

[note to selves] i created simple script and ran to generate new json file that reflects current nav YAML items and gave it to Julien yesterday. he is going to submit to smartling manually, and we can PR manually if it's back before this work is completed

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be automatically closed if no further activity occurs. Thank you for your contributions.

[roadlittledawn]

Was moved to jira