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

Automated Translation Workflows #181

Open
1 task done
Zeitsperre opened this issue Aug 7, 2024 · 0 comments
Open
1 task done

Automated Translation Workflows #181

Zeitsperre opened this issue Aug 7, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Zeitsperre
Copy link
Collaborator

Addressing a Problem?

From time to time, we want to be able to synchronize the French translation of the documentation with the existing API documentation. In order to do this, @RondeauG has written a script powered by a translation engine that can update existing po files. The issue is that running this manually can be easily forgotten.

Potential Solution

We can run this within our CI pipelines if we want. The necessary library requirements should be found in the requrements_ci.* files. We also need to draft a new workflow to do this and determine when we want to trigger it and how to accept changes from it.

Perhaps if we had a process that was triggered when API changes were made, then ran the script, committed the changes, and opened a Pull Review for us to verify, that could work? We could have a dedicated branch that rebases on main and solely adds translations.

Another option is to have this set up as a commit hook, which I detest:

  • Requires internet access to perform commit.
  • Setting repo-level hooks manually is somewhat involved as a process.
  • The script can sometimes return different results (AI-based) so failures/changes can happen very often.

Additional context

Related to #63

Contribution

  • I would be willing/able to open a Pull Request to contribute this feature.
@Zeitsperre Zeitsperre added the enhancement New feature or request label Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant