-
-
Notifications
You must be signed in to change notification settings - Fork 227
Add translation onboarding guide for DISCOVER Cookbook #377
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
Conversation
✅ Deploy Preview for stupendous-kringle-a86e81 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
OriolAbril
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left a small comment, @kamila-NF is the main one needed to review this
|
Undertsanding roles on Transifex: https://help.transifex.com/en/articles/6223416-understanding-user-roles Project MaintainerMaintainers are responsible for managing individual projects in Transifex. Maintainers can:
Team ManagerTeam Managers are responsible for who's on a team and assigning each member's role. Managers can:
The Team Manager role is valuable when working with translation agencies. Assign someone from the agency to be a Team Manager, and they can then invite their translators to work on your projects and assign them different roles. Language CoordinatorCoordinators are responsible for overseeing a particular language within a team. Coordinators can do the same things as a team manager, but on a language level:
If you're crowdsourcing translations, you can delegate some of the responsibility of managing a specific language to a trusted community member by promoting them from a translator or reviewer to a language coordinator. ReviewerReviewers play an essential role in ensuring translation quality. They check translations to ensure they're error-free and meet your quality standards. Once a translation is reviewed, it cannot be edited by a Translator. Reviewers can:
TranslatorTranslators work to adapt your content from one language to another. They can:
|
|
I believe we need only Translator, Reviewer and Language Coordinator roles; starting with a Translator. |
Add the roles in Translators Guide
OriolAbril
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left one comment, everything else looks good
Added the note that to begin with, everyone will join as translator, after few consistent translations and growth, they might get upgraded
…okbook into content-docs
| The source files and documentation are hosted on GitHub. | ||
| 🔗 [DISCOVER Cookbook GitHub Repo](https://github.com/numfocus/DISCOVER-Cookbook) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The only file translators care about is this one and the glossary+translation guidelines (if we add them). I would link directly there. One of the goals of using transifex is making it easy for people with no github knowledge to participate, so the less they have to interface with github the better I think
Translators_Guide.md
Outdated
|
|
||
| ### Acknowledgment | ||
|
|
||
| All contributors will be credited in accordance with the DISCOVER Cookbook license. Your name and language contribution will be listed in the final release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The license doesn't really say anything about credit, it only mentions copyright which is 100% held by NumFOCUS. Should this mention the contributors section on the readme?
Lincense: https://github.com/numfocus/DISCOVER-Cookbook/blob/main/LICENSE
Contributors section: https://github.com/numfocus/DISCOVER-Cookbook/tree/main?tab=readme-ov-file#contributors-
Translators_Guide.md
Outdated
| ## The Procedure – Roll-in Basis | ||
|
|
||
| We are onboarding translators on a rolling basis. Once accepted, you’ll be added to the platforms and can begin contributing right away. | ||
|
|
||
| - **Acceptance Process:** TBA | ||
| - **Instructions for Contributors:** TBA |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The blogpost and rest of the document hint against this being the case. I would delete that.
If the 1 month "translateathon" works we could do that after every release. If instead we move to rolling acceptance and no deadlines on translations I would rewrite the doc to remove all mentions to deadlines and timelines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We moved into the rolling acceptance. As NumFOCUS, we will react case by case.
The blog post with details.
|
@OriolAbril @emmasaroyan Could you take a look at this? Ideally, we’d like to have it approved by Monday, when the first translators begin their onboarding session. Thanks! |
|
My last round of comments is still pending to be addressed, after that it should be fine |
Adjusted the doc according to the doc
|
@OriolAbril I have adjusted the doc according to your feedback, please review it and let me know if there is still something to change |
OriolAbril
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am approving and I think we can merge already but there are still open points. I have gone over all comments in the PR and marked them as resolved with the exception of the following 3:
- link to github repository I don't see how a link to the repo homepage will help translators, especially if reading this document which is already on the github repo. Again, I think ideally this should point instead to the glossary and/or translation guide
- Attribution/aknowledgement. This is still something to be discussed with the translators and editorial team. The fact that the license doesn't cover it doesn't mean it shouldn't be taken into account, especially given there is the section in the readme with allcontributors style table (I don't know if that is maintained though)
- roll in applications. There are no longer mentions to the deadline but I am still not sure what exactly is the roll in process. The last section doesn't mention any application nor has any link to somewhere else with more info
Can you share the link of glosaary as I am not sure what that exactly is? |
|
|
I have opened #420 to tackle the translation guide and glossary leftover point |
Description of Changes
@OriolAbril @kamila-NF @emmasaroyan @aterrel
This guide supports volunteer translators contributing to the DISCOVER Cookbook localization project. It outlines the application process, onboarding steps, platform access (Transifex, Discord, GitHub), communication channels, instructions for using Transifex, and contributor acknowledgment. It also includes placeholders for roll-in procedures and contributor instructions post-pilot.
Related Issue
Type of Change
Please check the appropriate box that describes your PR:
Additional Notes (Optional)
Checklist