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

Make JSDoc for API files translateable #18704

Closed
1 of 3 tasks
tesseralis opened this issue Oct 16, 2019 · 2 comments
Closed
1 of 3 tasks

Make JSDoc for API files translateable #18704

tesseralis opened this issue Oct 16, 2019 · 2 comments

Comments

@tesseralis
Copy link
Contributor

tesseralis commented Oct 16, 2019

Summary

Much of the content of the API section of the website is directly sourced from documentation through Documentation.js. This content can't be as easily extracted for translation as markdown files or yaml strings, so we need to figure out a way to deal with them.

Steps

@gatsbot gatsbot bot added the type: question or discussion Issue discussing or asking a question about Gatsby label Oct 16, 2019
@tesseralis
Copy link
Contributor Author

Doing research, it seems like most of the API is documented in individual files:

The only one that isn't is node-model: https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/src/schema/node-model.js

Given this, the process should be something like

  • put these files in their own dedicated folder instead of just utils
  • factor out "api-node-model-docs"
  • extract these files into gatsby-i18n-source

@tesseralis tesseralis changed the title How do we translate text from source comments? Make JSDoc for API files translateable Nov 7, 2019
@tesseralis tesseralis added not stale topic: i18n and removed type: question or discussion Issue discussing or asking a question about Gatsby labels Nov 8, 2019
@muescha
Copy link
Contributor

muescha commented Nov 8, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants