Open MattBlissett opened 3 years ago
(We have since had a request for translating the IPT manual into traditional Chinese.)
A partial implementation of the Antora part is now ready on the IPT docs site, with the final process depending on whether CrowdIn improve their support sooner or later.
The process is a cut-down version of what the Fedora documentation uses.
See https://pagure.io/fedora-docs/docs-fp-o/tree/prod — a playbook per language, and some changes in the theme and supplemental-ui to link things together.
Also https://teams.fedoraproject.org/project/asamalik-antora-for-docs/epics and https://teams.fedoraproject.org/project/asamalik-antora-for-docs/epic/1
See https://github.com/gbif/tech-docs/tree/ipt and https://builds.gbif.org/job/tech-docs-ipt/
A remaining question is how to deal with partly-translated sites. Should the English content be shown still under the /es URL (and with a lang="en" tag, which isn't ideal) or should e.g. Apache redirect to the English content, which means further clicks stay in English?
How about displaying a page like "This content hasn't been translated to XX yet, please check the documentation in English. If you want to help us translate this documentation, please contact xxxx@gbif.org" in the language displayed?
relates to #36
General translation of the documentation is not planned, but the IPT already has a Spanish translation of the main part of the manual (from an older English version).
For the moment, this can be maintained as another "module" alongside the "ROOT" module, as in https://github.com/gbif/ipt/tree/ipt-2.4.2-docs/docs/en/modules and visible on https://tech-docs.gbif-dev.org/ipt/2.4.2/es/manual-del-usuario-del-ipt.html
Where multilingual documentation is needed, it will probably be best to use CrowdIn's native AsciiDoc support:
See https://gitlab.com/antora/antora/-/issues/208#note_65003980 for a suggested directory structure for translated documents, and comments on that issue for some progress on implementing this in Antora. (It might be possible but a bit hacky at the moment.)