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

Document copy/translation/i18n/PO file process #1447

Merged
merged 8 commits into from
Aug 15, 2023

Conversation

machikoyasuda
Copy link
Member

@machikoyasuda machikoyasuda commented Jun 23, 2023

closes #1446

What this PR does

  • Non-technical doc to document how we divide the responsibilities (Product, Design, Engineering) of getting application copy drafted, edited, approved, designed into Figma, translated, and finally, into the application in English and Spanish.
  • Most importantly, this page will have the link to the spreadsheet, that holds the English and Spanish translations -- so we don't have to get lost in Google Drive or various GitHub issues to find it.
  • This PR also updates Engineering's i18n docs with our new processes

Process

@github-actions github-actions bot added i18n Copy: Language files or Django i18n framework deployment-dev [auto] Changes that will trigger a deploy if merged to dev labels Jun 23, 2023
@machikoyasuda
Copy link
Member Author

machikoyasuda commented Jun 23, 2023

@indexing I started the Markdown file.

Please propose changes by making a GitHub comment on the line (or adding a suggestion commit https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-comments-to-a-pull-request, like I did here: https://github.com/cal-itp/benefits/pull/1447/files#r1239300498), and I can merge the suggestions in.

Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These docs are super helpful!

Can I suggest/request that we move them into a page in our /docs folder so they show up in the https://docs.calitp.org/benefits site and are more easily accessible for everyone? Maybe under the Configuration section?

We can still use the README in /benefits/locale to link to this online documentation (see an example of this pattern in the /terraform directory)

@machikoyasuda machikoyasuda added this to the Veterans milestone Jun 26, 2023
- Syncing copy from [Benefits String Spreadsheet](https://docs.google.com/spreadsheets/d/13YZLv7wf8dAk_HnEP-KLEUurTggx8QOx9HovEW4_UjI/edit#gid=0) into Figma.
- Ensuring the string is in the appropriate column (e.g. `Subtitle`, `ButtonLabel`)

### Engineering
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to add a reminder to run bin/makemessages.sh: #1436 (comment)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that #1571 is done, engineers should be editing copy directly in the app for English, then running bin/makemessages.sh, then updating the corresponding Spanish in the PO file.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@machikoyasuda
Copy link
Member Author

Current status

  • @indexing and @machikoyasuda met today to hand-off iBabbleOn process to @indexing
  • Once Andy re-formats the Google Spreadsheet to fit the translation needs, sends the request, receives the requested translations and hands the translations back to Dev, he can update the documentation for full deatils
  • Discussed how and where the new variables should be kept. Andy decided not to worry about getting the new variables ready and translated in this round. The variables can be written and translated in the next next round. I believe we have all the variable data for MST, SacRT, Veterans except for the [card functionality].. but I'm not 100% sure.
- [affected service]: public transportation or light rail or bus service
- [action]: reduce
- [rate of discount]: 50%
- [transit type]: fixed routes
- [card functionality]: tap this card when you get on and off the bus

@machikoyasuda
Copy link
Member Author

Lots of new stuff here: #1410 (comment)

@machikoyasuda
Copy link
Member Author

@machikoyasuda machikoyasuda marked this pull request as ready for review August 9, 2023 23:59
@machikoyasuda machikoyasuda requested a review from a team as a code owner August 9, 2023 23:59
@machikoyasuda
Copy link
Member Author

@machikoyasuda
Copy link
Member Author

@thekaveman @angela-tran Please review the updated i18n dev docs https://github.com/cal-itp/benefits/pull/1447/files#diff-739a6fd0a2d16786a1fad0499fde882753fee93043bb1f8b1a4b03ba5c75ea06

I tried covering all the new processes, but let me know if I'm missing anything!

@machikoyasuda machikoyasuda changed the title Document copy/translation process Document copy/translation/i18n/PO file process Aug 10, 2023
@thekaveman thekaveman added the documentation [auto] Improvements or additions to documentation label Aug 14, 2023
Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit about an internal link, but otherwise this is great and I'd say let's get it published!

docs/product-and-design/copy-delivery.md Outdated Show resolved Hide resolved
Co-authored-by: Kegan Maher <kegan@compiler.la>
@machikoyasuda machikoyasuda merged commit 8e99c02 into dev Aug 15, 2023
8 checks passed
@machikoyasuda machikoyasuda deleted the docs/copy-process-readme branch August 15, 2023 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployment-dev [auto] Changes that will trigger a deploy if merged to dev documentation [auto] Improvements or additions to documentation i18n Copy: Language files or Django i18n framework
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Copy process README.md
3 participants