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

Allow marking translations reviewed #392

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

fflorent
Copy link
Collaborator

When machine translations have been modified and reviewed, there is no need anymore to show this warning:

https://github.com/gristlabs/grist-help/blob/master/help/fr/MACHINE-TRANSLATION.md

I propose to add to the mkdocs.yml an extra config to mark translations as being reviewed.

Copy link

netlify bot commented Aug 27, 2024

Deploy Preview for grist-help-preview ready!

Name Link
🔨 Latest commit b7ba971
🔍 Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/66cda3da628dab00084dae1a
😎 Deploy Preview https://deploy-preview-392--grist-help-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dsagal
Copy link
Member

dsagal commented Aug 27, 2024

Might it be better to put such a marker into each page's meta data (https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data)?

@fflorent
Copy link
Collaborator Author

@dsagal I originally abandoned this idea: Git localize detects these metadata, so it would be expected that this property appears in both English and French (or any other language). I thought it would not be convenient, as the original writers (of the English version) have to keep in mind adding this property in the metadata.

But thinking again, what do you think of introducing a new command that does the following?

  • machine-translate any missing page for any language;
  • also machine-translate any page that have not been reviewed for the target languages when changes have been made in the English version;
  • also add the marker translation_reviewed: true in the English version of the page metadata and translation_reviewed: false in the others (so the admonition would appear);

We could make this run in Github actions every 24h, and/or on push on master, and/or when triggered manually (with a PR if some files have been updated).

The advantages are that:

  • the machine translations are nearly immediately available, with no action required;
  • the translators would have only the markdown file to update: they review and update the translation and at the end change the value of the marker translation_reviewed, and everything could be done through Git Localize;

The tricky part is that translators should keep track of the changes made in the English documentation (unless we find a way to tell GPT to only detect and translate parts of the documents that have been changed without overriding the existing reviewed translations). Something I still need to think of.

For the scope of this PR, I suggest that I put aside the machine translation and only make this command add the translation_reviewed marker, and use it in some Github action.

@fflorent
Copy link
Collaborator Author

Working on an idea, for now changing it to draft.

@fflorent fflorent marked this pull request as draft August 28, 2024 15:52
@fflorent
Copy link
Collaborator Author

fflorent commented Sep 4, 2024

Waiting for #396 to be merged before reopening and working again on this PR

@vviers vviers assigned vviers and fflorent and unassigned vviers Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

3 participants