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

Pull in translation repos as sources to gatsbyjs.org #19353

Closed
tesseralis opened this issue Nov 7, 2019 · 6 comments · Fixed by #20637
Closed

Pull in translation repos as sources to gatsbyjs.org #19353

tesseralis opened this issue Nov 7, 2019 · 6 comments · Fixed by #20637
Labels
help wanted Issue with a clear description that the community can help with.

Comments

@tesseralis
Copy link
Contributor

tesseralis commented Nov 7, 2019

Summary

Pull in translated content from translated repos like gatsby-es into the gatsby-config of www/

Details

Use gatsby-source-git or another plugin to pull in content from the translation repos.

Considerations:

  • Ideally, we should be able to query both the English docs and the translated docs the same way, and only need to differentiate them by passing a language code as a query parameter
  • While the translation repos only contain markdown files right now, they will also have YAML files and JSDoc files, so we need to make sure queries work for those as well.
  • For the majority of translation repos, the majority of content will not be translated yet. We need to find a way to differentiate this content and make sure we're not downloading or displaying unnecessary files.
  • We should have a way to easily "turn off" queries to other language so it is easier to iterate while developing.
@muescha
Copy link
Contributor

muescha commented Nov 8, 2019

the english docs can be git sourced from https://github.com/gatsbyjs/gatsby-i18n-source
then we also see if all is right exported and synced from gatsbyjs/gatsby docs (md/yaml/JSDoc)

@tesseralis
Copy link
Contributor Author

Ooh... that's not a bad idea! That reduces the chances of having to do something different for English and translated repos.

But then I'm wondering what's the point of keeping the docs in the monorepo and not just moving it to gatsby-i18n-source (which I guess we could rename to gatsby-en or something). I guess the benefit of keeping it locally is:

  • Contributors don't need to download two different repos
  • When running a dev build, we could source from the local filesystem instead of git to be faster

Thanks for the suggestion :)

@muescha
Copy link
Contributor

muescha commented Nov 8, 2019

  • searching for for some code (a methodname) or similar in one repo is more easy then over 2 seperate repos.
  • then docs are better found for updates.
  • updates to docs and code can also be done in one PR.

todo: add an issue template for pull request/issues with information that this is only a technical repo and all should be gone to the main repo ( -> #19381)

@tesseralis
Copy link
Contributor Author

@muescha would you be interested in helping implement this?

@muescha
Copy link
Contributor

muescha commented Nov 8, 2019

@tesseralis sorry - i am not so familiar with this :(

@tesseralis tesseralis added the help wanted Issue with a clear description that the community can help with. label Nov 8, 2019
@mi-na-bot
Copy link
Contributor

This is an issue I might look into if #19297 goes well. They are fairly complementary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issue with a clear description that the community can help with.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants