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

feat(docs): Guide for syncing translation repos #21753

Merged
merged 76 commits into from
Mar 4, 2020
Merged

feat(docs): Guide for syncing translation repos #21753

merged 76 commits into from
Mar 4, 2020

Conversation

tesseralis
Copy link
Contributor

@tesseralis tesseralis commented Feb 25, 2020

Description

Split off from #21185 so we can merge this in quicker.

TODO:

  • Update with more realistic scenarios taken from actual sync PRs
  • More tips, like syncing with VS Code

@tesseralis tesseralis requested a review from a team as a code owner February 25, 2020 21:16
@tesseralis tesseralis changed the title feat(docs): Guide for syncing translation repos feat(docs): Guide for syncing translation repos (WIP) Feb 25, 2020
@tesseralis tesseralis changed the title feat(docs): Guide for syncing translation repos (WIP) feat(docs): Guide for syncing translation repos Feb 27, 2020
@tesseralis
Copy link
Contributor Author

Okay, I think I have all the content I want for this page, so I'm marking this as a final draft.

The main issue I'm coming up against is what to use for examples of different sync conflicts:

  • Real examples taken from actual sync conflicts
  • Fake examples in a single real language

I think the issue is, if we use a real language, it might be difficult for translators who don't speak the language to figure out what the solution is. I was thinking of using a fake language like Pig Latin -- or maybe just US versus UK English, and providing instructions for translator maintainers to translate the examples to their own language. Please let me know what your thoughts are on this!

@AishaBlake
Copy link

Sorry, was expecting my mention of this to show up in the timeline at least! I like US vs Pig Latin, personally.

@AishaBlake
Copy link

I agree that the content looks good. (Literally just the one typo.) Comparing with #21185, I feel like this will cover everything we really need once you've made a call on the sync conflict examples.

Co-Authored-By: Aisha Blake <aisha@gatsbyjs.com>
@tesseralis
Copy link
Contributor Author

tesseralis commented Feb 27, 2020

Sorry, was expecting my mention of this to show up in the timeline at least! I like US vs Pig Latin, personally.

I think the issue with Pig Latin is that it's culturally dependent, and contributors from non-English backgrounds may be unfamiliar with it, e.g. not realizing it's a fake language.

Copy link
Contributor

@muescha muescha left a comment

Choose a reason for hiding this comment

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

add language tags

docs/contributing/translation/sync-guide.md Outdated Show resolved Hide resolved
docs/contributing/translation/sync-guide.md Outdated Show resolved Hide resolved
tesseralis and others added 2 commits February 27, 2020 21:34
Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>
Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>
@AishaBlake
Copy link

Sorry, was expecting my mention of this to show up in the timeline at least! I like US vs Pig Latin, personally.

I think the issue with Pig Latin is that it's culturally dependent, and contributors from non-English backgrounds may be unfamiliar with it, e.g. not realizing it's a fake language.

That's fair. My thought is that, given the same content in English and Pig Latin, a contributor might recognize the pattern even if they don't know Pig Latin is a thing. It's also more obviously distinct than US vs UK.

Copy link

@AishaBlake AishaBlake left a comment

Choose a reason for hiding this comment

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

@tesseralis I'm happy with this doc. The only version of the examples I'd prefer to avoid would be a US/UK English comparison because I feel like it would be less clear. I think you're fine either keeping the real language or switching to a fake one.

@AishaBlake AishaBlake added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants