#Is there any work in progress on the multi-language documentation setup?

1 messages · Page 1 of 1 (latest)

grizzled cargo
#

Coming from this message: #off-topic message 👋

Is there any work in progress on the multi-language documentation setup? I find Litestar quite interesting and I would like to work on translating the documentation into Turkish (at least some pages). I'm actively contributing to FastAPI Documentation and I also did some work on the starlette-admin documentation 😋.

Keep in mind that I'm not familiar with sphinx and .rst file format but if the CONTRIBUTING guide describes the process, I'll do my best 🙏.

manic pagoda
ember heronBOT
manic pagoda
ember heronBOT
manic pagoda
#

The other maintainers may have some insight into this process (namely @tribal anchor as he is most familiar with Sphinx and may have looked into this for German or something)

brazen saddle
#

not the format I am suggesting, but to track

- [ ] Chinese (or new language someone wants)
   - Assigned Translator = none for now
tribal anchor
#

There's currently no progress and no plans of adding translations

#

We should definitely consider the amount of effort to maintain documentation in multiple languages

#

A missing translation is worse than an out-of-date translated documentation IMO, so unless we're confident we can keep it up, I'd be cautious to adding this

manic pagoda
manic pagoda
#

sphinx-intl seems to generate current work and if there is not entry for it just keeps the original english
https://docs.readthedocs.io/en/stable/guides/manage-translations-sphinx.html

But, the automatic way via Transifex looks promising

Read the Docs Documentation

This guide walks through the process needed to manage translations of your documentation. Once this work is done, you can setup your project under Read the Docs to build each language of your documentation by reading Localization of documentation. Overview: There are many different ways to manage...

#

For the low price of free as in Freedom freedomland

manic pagoda
grizzled cargo
ember heronBOT
# grizzled cargo FastAPI Documentation doesn't have a way to track outdated translations but it t...

@hasansezertasan My only concern with manual translations is how will we maintain it as we update our docs over time? How have you seen this handled in other projects?

I thought about this often while translating the FastAPI Documentation, and there is even a discussion on it (tiangolo/fastapi#10872), but there is no clear solution there. Expired (outdated) translations need to be detected and reported.

This page at FastAPI documentation doesn't have a Turkish translation at the moment: General - How To - Recipes - FastAPI, that's why you see "The current page still doesn't have a translation for this language." message. It can tell if there is a translation page or not.

I think it also should tell or highlight if the translation is up to date or not.

How do we detect it? I can think of only one solution.

A script that tracks the modification dates of the original markdown files and keeps a log for that (in JSON maybe).

And we can use that log to let people know if the current translation is up to date or not.

Consider this directory as documentation tree:

- docs
  - index.md  # Original File - Modified today
  - index.tr.md  # Turkish Translation - Modified yesterday
  - track.json

This is the example for track.json

{
    "index_tr_md": {
        "outdated": true
    }
}

This is the example for index.md:

# This is the index!

This is the example for index.tr.md

{% if index_tr_md.outdated %}
Bu sayfa güncel değil.
{% endif %}

# Bu giriş sayfasıdır.

"Bu sayfa güncel değil." means "This page is not up to date".

What I'm talking about is a rough example.

grizzled cargo
manic pagoda
#

curious why not crowdin? (i dont like it either just wondering)

#

also curious @brazen saddle mentioned something similar but code and all is in english - how does the rest of the docs being in not english help? is it just easier or quicker to understand? im only english speaking so i cant quite wrap my head around it (but trying to learn!)