Provide a translation dashboard

[AA-Turner]

The most recent documentation monthly meeting discussed providing a dashboard for the translations and progress.

Suggestions:

• [x] Link to Maciej's dashoard from the devguide
  • https://m-aciek.github.io/pydocs-translation-dashboard/
  • https://github.com/m-aciek/pydocs-translation-dashboard/
  • cc @m-aciek
• [x] Add translation contribution links to the dashboard
• [x] ~~Perhaps move the dashboard to docs.python.org/translations~~ Currently hosted https://python-docs-translations.github.io/dashboard/ which is good for now
  • ~~This could be achieved by plugging in to docsbuild-scripts~~

Relevant prior art: https://translations.react.dev/

A

[m-aciek]

I'm happy to move the repo to Python org on GitHub or to integrate it into docs-build scripts repo. I was about to add a permissive license info (MIT?) to the project, will try to do it soon.

contribution links

What do you mean by that? Linking to devguide/translating from dashboard? Or some other per-language-project links?

[AA-Turner]

I'm happy to move the repo to Python org on GitHub or to integrate it into docs-build scripts repo. I was about to add a permissive license info (MIT?) to the project, will try to do it soon.

Wonderful! Make sure that all others with copyrightable contributions consent.

MIT seems fine, other options could include CC-1.0 (used by PEPs code) or 0BSD (used in pythoncapi-compat), but these are more permissive.

My preference would be to include it in docsbuild-scripts, but others may have a different view -- let's wait for other comments.

What do you mean by that?

Sorry for being unclear, I meant links to contribute to each translation, like on the React dashboard.

A

[adorilson]

• Add translation contribution links to the dashboard

This is already provided by the language column in Maciej's dashboard. Or not?

• Perhaps move the dashboard to docs.python.org/translations

What about updating https://devguide.python.org/documentation/translating/ with dashboard data instead of creating a new page?

[AA-Turner]

The language column links to the repo, which often isn't where to directly translate text. I envisaged linking to both the repo and eg transifex.

I suggest having a dedicated page to allow updating more frequently and to allow it to be single purpose. We could put this in the devguide but it feels like a bit of a stretch to include dashboard-like content.

A

[adorilson]

The language column links to the repo, which often isn't where to directly translate text. I envisaged linking to both the repo and eg transifex.

So, do you mean the Link column at https://devguide.python.org/documentation/translating/#translating ?

I suggest having a dedicated page to allow updating more frequently and to allow it to be single purpose. We could put this in the devguide but it feels like a bit of a stretch to include dashboard-like content.

My concern is about avoiding duplication and/or fragmentation. Maybe we can do the opposite: move the table on the page above to the dashboard (I mean not the table itself, but the content) and keep the paragraph and link to the dashboard. Something like:

[hugovk]

Wonderful! Make sure that all others with copyrightable contributions consent.

MIT seems fine, other options could include CC-1.0 (used by PEPs code) or 0BSD (used in pythoncapi-compat), but these are more permissive.

I've contributed. I consent to MIT, CC-1.0 and 0BSD, and open to considering others.

[m-aciek]

Thank you for your license suggestions, I've open a PR with CC0, yet waiting for Matt's consent.

Does it make sense to move the repository to Python GitHub org? If so I will pass the ownership to @hugovk or @AA-Turner to let move the repository. (I'm not a member of Python org on GitHub.)

I envisaged linking to both the repo and eg transifex.

Heuristics to programmatically deduct if a language actively uses the Transifex is not trivial. In particular Traditional Chinese used to use Transifex and has e.g. the TX config in the repo, but currently uses pull requests. ~~For now I'm taking it as a challange, and in some time will try to parse and analyze GitHub workflows to see if they install the TX client (or similar).~~ If it occurs not feasible, we may need to introduce kind of config in the dashboard source code (up to now the dashboard doesn't have config, all data is derived from devguide, docsbuild-scripts and source repositories).

Update: I've introduced static data in a PR.

[StanFromIreland]

Perhaps move the dashboard to docs.python.org/translations

Why not do what the linked React example has done -- translations.python.org?

Is this viable? cc @ewdurbin

The Python Transifex docs (They describe the Transifex management and have useful guides for new contributors) could also be moved there.

[AA-Turner]

There's no decision on moving it yet, so let's not bother the infrastructure team. I don't think we're in a rush?

A

[willingc]

Right now, https://python-docs-translations.github.io/dashboard/ hosts the translations dashboard.

[willingc]

@ewdurbin Sorry about the ping. No action is needed on your part now. Thanks!

[StanFromIreland]

The dashboard has since changed quite a lot, I think it makes sense to rethink move it elsewhere now. As to where, maybe one of:

• docs.python.org/translations
  • The main downside I see is that that the people working on the dashboard will be unable to freely do so anymore.
  • Might limit the re-generation frequency?
• translations.python.org
  • Like the prior art Adam listed: https://translations.react.dev/
  • I believe it is the easiest to implement, only a few settings changes in the existing repo
• devguide.python.org/documentation/translations/dashboard/
  • Similar issue to the docs.python.org ones

[StanFromIreland]

All tick-boxes have been completed, closing.

[willingc]

Nice work @StanFromIreland. Great to see the dashboard becoming more visible with its own landing page.