search

google / mdbook-i18n-helpers

Translation support for mdbook. The plugins here give you a structured way to maintain a translated book.
Apache License 2.0
127 stars 25 forks source link

Add scripts for using and updating translations #18

Open mgeisler opened 1 year ago

mgeisler commented 1 year ago

The instructions for our translation pipeline in TRANSLATIONS.md don't match the actual steps in publish.yml.

The difference is mostly because of how the GitHub Actions allows us to set environment variables using a different syntax.

I would like to unify the two via small scripts. The scripts could be shell scripts (though that probably doesn't work well on Windows?) or they could be Rust "scripts" (more setup time).

I'm imagining something like

A serve-translation would probably also be nice to have.

Instead of several scripts, a single script with subcommands could also be nice. That could probably live nicely in the i18n-helpers project since it would be tightly coupled to the other binaries there.

mgeisler commented 1 year ago

The GitHub action in #48 could call into this script and so we avoid putting too much logic into the action (GitHub actions are nice in the context of GitHub, but they're hard to run by hand on your local machine).