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

Explore supporting different languages for our docs #2922

Closed
cindyorangis opened this issue Feb 14, 2022 · 8 comments · Fixed by #3041
Closed

Explore supporting different languages for our docs #2922

cindyorangis opened this issue Feb 14, 2022 · 8 comments · Fixed by #3041
Assignees
Labels
area: docusaurus Anything related to Docusaurus developer experience Helping the Developer Experience help wanted Extra attention is needed type: discussion Requires conversation type: documentation (docs) Improvements or additions to documentation type: nice to have Feature that'd be nice to have, but not a priority
Milestone

Comments

@cindyorangis
Copy link
Contributor

Docusaurus has a tutorial on the basics of the Docusaurus i18n system. I don't know any languages well enough to translate but if we had someone on the team willing to try this out, I help get this rolling. This would pave the way for Hacktoberfest contributors since it seems to be pretty popular to translate docs for that event. We can try a single doc first.

@cindyorangis cindyorangis added type: documentation (docs) Improvements or additions to documentation help wanted Extra attention is needed developer experience Helping the Developer Experience type: nice to have Feature that'd be nice to have, but not a priority area: docusaurus Anything related to Docusaurus labels Feb 14, 2022
@humphd
Copy link
Contributor

humphd commented Feb 14, 2022

I wonder when the right time to do this is? I suspect that localizing fast-moving docs is going to be hard. Probably a goal of 3.0 should be to have the docs stay relatively stable for the 3.x lifecycle. In the 4.x lifecycle, we could revamp them.

That means, we should plan out what needs to get written between now and 3.0, and file those issues.

@cindyorangis
Copy link
Contributor Author

cindyorangis commented Feb 14, 2022

I imagine this would be a post-3.0 thing since we're still waiting on a number of docs to be added:

and I'm sure there will be new docs that need to be written before 3.0

We also need to dogfood and audit the docs before they're ready to be translated

@sirinoks
Copy link
Contributor

I'm down to translate to Russian

@humphd
Copy link
Contributor

humphd commented Feb 14, 2022

One thing I'm going to push people on re: translation, is that they have to build a team. Just like I wouldn't let a student drop a PR in some programming language none of us knows, there's no way I'm going to take a translation that I have to maintain without it also arriving as part of a team.

Years ago, a bunch of my Ukrainian students got together and translated the Rect docs as a team, see https://uk.reactjs.org/. It was inspiring to watch. We can do the same for Telescope, but we need to build some teams of people to do the work, and people to review, and ideally, people who want to help maintain it later.

@cindyorangis cindyorangis added the type: discussion Requires conversation label Feb 14, 2022
@sirinoks
Copy link
Contributor

There's a tool I saw used for Staxel translations, where it automatically makes tables with original and translation columns and it's really nice to use for non developers. I'm not sure what it was though..

@TueeNguyen
Copy link
Contributor

Should this be closed? We haven't implemented the full feature

@aserputov
Copy link
Contributor

aserputov commented Mar 5, 2022

@TueeNguyen I think this one closed automatically because I merged PR. Thanks.

@tpmai22
Copy link
Contributor

tpmai22 commented Mar 11, 2022

We got this keeping track in #2962

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docusaurus Anything related to Docusaurus developer experience Helping the Developer Experience help wanted Extra attention is needed type: discussion Requires conversation type: documentation (docs) Improvements or additions to documentation type: nice to have Feature that'd be nice to have, but not a priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants