Skip to content
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.

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

Add docs for including machine-generated Arabic translations in e2e tests #3877

Closed
zackkrida opened this issue Mar 5, 2024 · 1 comment
Closed
Labels
♿️ aspect: a11y Concerns related to the project's accessibility 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation

Comments

@zackkrida
Copy link
Member

Problem

We currently have an undocumented practice: Whenever we add new text to Openverse requiring translation, which is included in Visual regression tests whose snapshots are updated, we hardcode manual Arabic translations to the https://github.com/WordPress/openverse/blob/main/frontend/test/locales/ar.json file. This allows us to approximate how RTL and Arabic support looks in the actual site.

You can see this process in action on this PR.

Description

Add docs explaining how this works, and instructing folks to go to translate.google.com to get a machine translation, to https://docs.openverse.org/frontend/guides/translate.html.

@zackkrida zackkrida added 🟨 priority: medium Not blocking but should be addressed soon 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users ♿️ aspect: a11y Concerns related to the project's accessibility 🧱 stack: documentation Related to Sphinx documentation labels Mar 5, 2024
@openverse-bot openverse-bot moved this to 📋 Backlog in Openverse Backlog Mar 5, 2024
@stacimc stacimc removed the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Mar 6, 2024
@obulat
Copy link
Contributor

obulat commented Apr 8, 2024

#3725 has added a script for getting the Arabic translation automatically, and also added documentation for it: https://docs.openverse.org/frontend/reference/i18n.html#test-locales

@obulat obulat closed this as completed Apr 8, 2024
@openverse-bot openverse-bot moved this from 📋 Backlog to ✅ Done in Openverse Backlog Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
♿️ aspect: a11y Concerns related to the project's accessibility 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

No branches or pull requests

3 participants