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

Set up translations for docs #1055

Closed
tiangolo opened this issue Feb 29, 2020 · 5 comments
Closed

Set up translations for docs #1055

tiangolo opened this issue Feb 29, 2020 · 5 comments
Labels
confirmed docs Documentation about how to use FastAPI feature New feature or request reviewed

Comments

@tiangolo
Copy link
Owner

Is your feature request related to a problem

Nope.

Several community members have proposed and offered help adding translations to other languages.

Portuguese: #921
Chinese: discussed with https://twitter.com/linupy1 on Twitter
Spanish: at least I would do it, I hope others would be willing to help 😄

The solution you would like

I have to set up a simple way to add translations.

I think it will be adding a copy of the same MkDocs files for each language and including all that on a sub path.

It will probably include copying each original English file that is not translated and adding a note about its translation.

And there should also be a way to add a note about translations that need to be re-synchronized with the original English version.

There should also probably be a note about translations being provided by the community and that the "official" version is always English.

The translation process would probably be page by page in a separated PR. That way others can review those translations in small amounts.

It would probably depend a lot on each PR getting several PR approvals by community members. I can verify and check Spanish and, to some extent, Portuguese. But for example, I don't speak Japanese, Chinese, nor Rusian. And there's a lot of content about FastAPI in those languages, I suspect those would be some of the first translations.

Describe alternatives you've considered

Not adding translations at all.

Waiting for MkDocs to have official support for translations mkdocs/mkdocs#617 , but as this is a complex topic, I expect that to take some time. And we can have a simple version that works, at least just for FastAPI.

Additional context

🌍 🤷‍♂️

@tiangolo tiangolo added feature New feature or request docs Documentation about how to use FastAPI confirmed labels Feb 29, 2020
@pyropy
Copy link

pyropy commented Mar 9, 2020

@tiangolo I can help with translations to Serbian

@yutayamazaki
Copy link

@tiangolo I would like to help translate into Japanese.

@tiangolo
Copy link
Owner Author

tiangolo commented Mar 27, 2020

We have it now! 🌍 🚀

Here are the new docs for contributing translations to FastAPI: https://fastapi.tiangolo.com/contributing/#translations

And I think it ended up quite easy to use/set up. ✨ 🎉

Thanks @pyropy , @yutayamazaki , @linupychiang, @juhovh-aiven, @seu-pedro for your offer and/or help! It's very much appreciated 🍰 🌍

@waynerv
Copy link
Contributor

waynerv commented Mar 27, 2020

@tiangolo
We(@Dustyposa ) have formed a small team to complete the translation of Chinese version. Interested friends are welcome to join us.

@tiangolo
Copy link
Owner Author

tiangolo commented Apr 5, 2020

Thanks for doing it @waynerv, @Dustyposa, and everyone contributing!

If you want, feel free to create a new issue to coordinate Chinese translation and I will pin it. There's currently one for Portuguese translations #1211

As we now have the translations system and workflow more or less set up I'll now close this issue.

@tiangolo tiangolo closed this as completed Apr 5, 2020
@tiangolo tiangolo changed the title [FEATURE] Set up translations for docs Set up translations for docs Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed docs Documentation about how to use FastAPI feature New feature or request reviewed
Projects
None yet
Development

No branches or pull requests

4 participants